[arrow] branch master updated: ARROW-4906: [Format] Write about SparseMatrixIndexCSR format is sorted

[wesm]

This is an automated email from the ASF dual-hosted git repository.

wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new 066ee43  ARROW-4906: [Format] Write about SparseMatrixIndexCSR format 
is sorted
066ee43 is described below

commit 066ee43960b66a4ee0fe778fdc4a71d2c23d211b
Author: Kenta Murata <m...@mrkn.jp>
AuthorDate: Sun Mar 17 11:03:37 2019 -0500

    ARROW-4906: [Format] Write about SparseMatrixIndexCSR format is sorted
    
    Currently, my implementation of SparseCSRIndex assumes indptr is sorted for 
each row.
    So I want to note it in the format documentation just in case.
    
    Author: Kenta Murata <m...@mrkn.jp>
    
    Closes #3929 from mrkn/fix_sparse_tensor_doc and squashes the following 
commits:
    
    b851bb723 <Kenta Murata> Write about SparseMatrixIndexCSR format is sorted
---
 format/SparseTensor.fbs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/format/SparseTensor.fbs b/format/SparseTensor.fbs
index 0a0c6c2..853dd19 100644
--- a/format/SparseTensor.fbs
+++ b/format/SparseTensor.fbs
@@ -49,7 +49,7 @@ table SparseTensorIndexCOO {
   ///    [2, 2, 3, 1, 2, 0],
   ///    [0, 1, 0, 0, 3, 4]]
   ///
-  /// Note that the indices are sorted in lexcographical order.
+  /// Note that the indices are sorted in lexicographical order.
   indicesBuffer: Buffer;
 }
 
@@ -86,6 +86,8 @@ table SparseMatrixIndexCSR {
   /// For example, the indices of the above X is:
   ///
   ///   indices(X) = [1, 2, 2, 1, 3, 0, 2, 3, 1].
+  ///
+  /// Note that the indices are sorted in lexicographical order for each row.
   indicesBuffer: Buffer;
 }