Skip to content

Commit

Permalink
improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jparismorgan committed Oct 15, 2024
1 parent ae871ac commit aa311a0
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions src/include/detail/linalg/tdb_matrix_multi_range.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,13 @@ class tdbBlockedMatrixMultiRange : public Matrix<T, LayoutPolicy, I> {
* @param uri URI of the TileDB array to read.
* @param indices The indices of the columns to read.
* @param dimensions The number of dimensions in each vector.
* @param upper_bound The maximum number of vectors to read.
* @param query_type The type of query to perform.
* @param column_indices The indices of the columns to read. Should only be
* passed with QueryType::ColumnIndices.
* @param column_slices The slices of the columns to read. Should only be
* passed with QueryType::ColumnSlices.
* @param total_num_columns The total number of columns in the array.
* @param upper_bound The maximum number of vectors to read in at once.
* @param temporal_policy The TemporalPolicy to use for reading the array
* data.
*/
Expand Down Expand Up @@ -172,9 +178,9 @@ class tdbBlockedMatrixMultiRange : public Matrix<T, LayoutPolicy, I> {
*
* @param ctx The TileDB context to use.
* @param uri URI of the TileDB array to read.
* @param column_indices The indices of the columns to read.
* @param dimensions The number of dimensions in each vector.
* @param upper_bound The maximum number of vectors to read.
* @param column_indices The indices of the columns to read.
* @param upper_bound The maximum number of vectors to read in at once.
* @param temporal_policy The TemporalPolicy to use for reading the array
* data.
*/
Expand Down Expand Up @@ -205,9 +211,10 @@ class tdbBlockedMatrixMultiRange : public Matrix<T, LayoutPolicy, I> {
*
* @param ctx The TileDB context to use.
* @param uri URI of the TileDB array to read.
* @param column_slices The slices of the columns to read.
* @param dimensions The number of dimensions in each vector.
* @param upper_bound The maximum number of vectors to read.
* @param column_slices The slices of the columns to read.
* @param total_slices_size The total number of columns in the slices.
* @param upper_bound The maximum number of vectors to read in at once.
* @param temporal_policy The TemporalPolicy to use for reading the array
* data.
*/
Expand Down

0 comments on commit aa311a0

Please sign in to comment.