@@ -29,8 +29,8 @@ class preprocessed_table;
2929namespace cudf {
3030namespace detail {
3131/* *
32- * @brief Hash join that builds hash table in creation and probes results in subsequent `*_join`
33- * member functions.
32+ * @brief Hash join that builds a hash table with the right table on construction and probes
33+ * results in subsequent `*_join` member functions.
3434 *
3535 * User-defined hash function can be passed via the template parameter `Hasher`
3636 *
@@ -50,17 +50,17 @@ class hash_join {
5050 hash_join& operator =(hash_join&&) = delete ;
5151
5252 /* *
53- * @brief Constructor that internally builds the hash table based on the given `build ` table.
53+ * @brief Constructor that internally builds the hash table from the given `right ` table.
5454 *
55- * @throw cudf::logic_error if the number of columns in `build ` table is 0.
55+ * @throw cudf::logic_error if the number of columns in `right ` table is 0.
5656 *
57- * @param build The build table, from which the hash table is built.
58- * @param has_nulls Flag to indicate if the there exists any nulls in the `build ` table or
59- * any `probe ` table that will be used later for join.
57+ * @param right The right table, from which the hash table is built.
58+ * @param has_nulls Flag to indicate if the there exists any nulls in the `right ` table or
59+ * any `left ` table that will be used later for join.
6060 * @param compare_nulls Controls whether null join-key values should match or not.
6161 * @param stream CUDA stream used for device memory operations and kernel launches.
6262 */
63- hash_join (cudf::table_view const & build ,
63+ hash_join (cudf::table_view const & right ,
6464 bool has_nulls,
6565 cudf::null_equality compare_nulls,
6666 rmm::cuda_stream_view stream);
@@ -70,7 +70,7 @@ class hash_join {
7070 *
7171 * @param load_factor The hash table occupancy ratio in (0,1]. A value of 0.5 means 50% occupancy.
7272 */
73- hash_join (cudf::table_view const & build ,
73+ hash_join (cudf::table_view const & right ,
7474 bool has_nulls,
7575 cudf::null_equality compare_nulls,
7676 double load_factor,
@@ -81,7 +81,7 @@ class hash_join {
8181 */
8282 [[nodiscard]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
8383 std::unique_ptr<rmm::device_uvector<size_type>>>
84- inner_join (cudf::table_view const & probe ,
84+ inner_join (cudf::table_view const & left ,
8585 std::optional<std::size_t > output_size,
8686 rmm::cuda_stream_view stream,
8787 rmm::device_async_resource_ref mr) const ;
@@ -91,7 +91,7 @@ class hash_join {
9191 */
9292 [[nodiscard]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
9393 std::unique_ptr<rmm::device_uvector<size_type>>>
94- left_join (cudf::table_view const & probe ,
94+ left_join (cudf::table_view const & left ,
9595 std::optional<std::size_t > output_size,
9696 rmm::cuda_stream_view stream,
9797 rmm::device_async_resource_ref mr) const ;
@@ -101,83 +101,83 @@ class hash_join {
101101 */
102102 [[nodiscard]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
103103 std::unique_ptr<rmm::device_uvector<size_type>>>
104- full_join (cudf::table_view const & probe ,
104+ full_join (cudf::table_view const & left ,
105105 std::optional<std::size_t > output_size,
106106 rmm::cuda_stream_view stream,
107107 rmm::device_async_resource_ref mr) const ;
108108
109109 /* *
110110 * @copydoc cudf::hash_join::inner_join_size
111111 */
112- [[nodiscard]] std::size_t inner_join_size (cudf::table_view const & probe ,
112+ [[nodiscard]] std::size_t inner_join_size (cudf::table_view const & left ,
113113 rmm::cuda_stream_view stream) const ;
114114
115115 /* *
116116 * @copydoc cudf::hash_join::left_join_size
117117 */
118- [[nodiscard]] std::size_t left_join_size (cudf::table_view const & probe ,
118+ [[nodiscard]] std::size_t left_join_size (cudf::table_view const & left ,
119119 rmm::cuda_stream_view stream) const ;
120120
121121 /* *
122122 * @copydoc cudf::hash_join::full_join_size
123123 */
124- [[nodiscard]] std::size_t full_join_size (cudf::table_view const & probe ,
124+ [[nodiscard]] std::size_t full_join_size (cudf::table_view const & left ,
125125 rmm::cuda_stream_view stream,
126126 rmm::device_async_resource_ref mr) const ;
127127
128128 /* *
129129 * @copydoc cudf::hash_join::inner_join_match_context
130130 */
131131 [[nodiscard]] cudf::join_match_context inner_join_match_context (
132- cudf::table_view const & probe ,
132+ cudf::table_view const & left ,
133133 rmm::cuda_stream_view stream,
134134 rmm::device_async_resource_ref mr) const ;
135135
136136 /* *
137137 * @copydoc cudf::hash_join::left_join_match_context
138138 */
139139 [[nodiscard]] cudf::join_match_context left_join_match_context (
140- cudf::table_view const & probe ,
140+ cudf::table_view const & left ,
141141 rmm::cuda_stream_view stream,
142142 rmm::device_async_resource_ref mr) const ;
143143
144144 /* *
145145 * @copydoc cudf::hash_join::full_join_match_context
146146 */
147147 [[nodiscard]] cudf::join_match_context full_join_match_context (
148- cudf::table_view const & probe ,
148+ cudf::table_view const & left ,
149149 rmm::cuda_stream_view stream,
150150 rmm::device_async_resource_ref mr) const ;
151151
152152 private:
153153 bool const _is_empty; // /< true if `_hash_table` is empty
154- bool const _has_nulls; // /< true if nulls are present in either build table or any probe table
154+ bool const _has_nulls; // /< true if nulls are present in either right table or any left table
155155 cudf::null_equality const _nulls_equal; // /< whether to consider nulls as equal
156- cudf::table_view _build ; // /< input table to build the hash map
156+ cudf::table_view _right ; // /< input table to build the hash map
157157 std::shared_ptr<cudf::detail::row::equality::preprocessed_table>
158- _preprocessed_build ; // /< input table preprocssed for row operators
158+ _preprocessed_right ; // /< input table preprocssed for row operators
159159 std::unique_ptr<impl> _impl; // /< CUDA hash table implementation
160160
161161 [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> make_match_counts (
162162 join_kind join,
163- cudf::table_view const & probe ,
163+ cudf::table_view const & left ,
164164 rmm::cuda_stream_view stream,
165165 rmm::device_async_resource_ref mr) const ;
166166
167167 template <join_kind Join>
168168 [[nodiscard]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
169169 std::unique_ptr<rmm::device_uvector<size_type>>>
170- join_retrieve (cudf::table_view const & probe ,
170+ join_retrieve (cudf::table_view const & left ,
171171 std::optional<std::size_t > output_size,
172172 rmm::cuda_stream_view stream,
173173 rmm::device_async_resource_ref mr) const ;
174174
175175 template <join_kind Join>
176- [[nodiscard]] std::size_t join_size (cudf::table_view const & probe ,
176+ [[nodiscard]] std::size_t join_size (cudf::table_view const & left ,
177177 rmm::cuda_stream_view stream) const ;
178178
179179 template <join_kind Join>
180- [[nodiscard]] std::size_t join_size (cudf::table_view const & probe ,
180+ [[nodiscard]] std::size_t join_size (cudf::table_view const & left ,
181181 rmm::cuda_stream_view stream,
182182 rmm::device_async_resource_ref mr) const ;
183183};
0 commit comments