Browse Source

Doc: starpu_bcsr_data_register().

Cyril Roelandt 13 years ago
parent
commit
001e8825ad
1 changed files with 7 additions and 1 deletions
  1. 7 1
      doc/chapters/basic-api.texi

+ 7 - 1
doc/chapters/basic-api.texi

@@ -525,7 +525,13 @@ starpu_block_data_register(&block_handle, 0, (uintptr_t)block,
 @deftypefun void starpu_bcsr_data_register (starpu_data_handle_t *@var{handle}, uint32_t @var{home_node}, uint32_t @var{nnz}, uint32_t @var{nrow}, uintptr_t @var{nzval}, uint32_t *@var{colind}, uint32_t *@var{rowptr}, uint32_t @var{firstentry}, uint32_t @var{r}, uint32_t @var{c}, size_t @var{elemsize})
 This variant of @code{starpu_data_register} uses the BCSR (Blocked
 Compressed Sparse Row Representation) sparse matrix interface.
-TODO
+Register the sparse matrix made of @var{nnz} non-zero values of size
+@var{elemsize} stored in @var{nzval} and initializes @var{handle} to represent
+it. Blocks have size @var{r} * @var{c}. @var{nrow} is the number of rows (in
+terms of blocks), @var{colind} is the list of positions of the non-zero entries
+on the row, @var{rowptr} is the index (in nzval) of the first entry of the row.
+@var{fristentry} is the index of the first entry of the given arrays (usually 0
+or 1).
 @end deftypefun
 
 @deftypefun void starpu_csr_data_register (starpu_data_handle_t *@var{handle}, uint32_t @var{home_node}, uint32_t @var{nnz}, uint32_t @var{nrow}, uintptr_t @var{nzval}, uint32_t *@var{colind}, uint32_t *@var{rowptr}, uint32_t @var{firstentry}, size_t @var{elemsize})