Documentation update, fixes #30

tdegeus · Jul 17, 2018 · 3f048ff · 3f048ff
1 parent 11a31a9
commit 3f048ff
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/docs/cppmat_var_diagonal.rst b/docs/cppmat_var_diagonal.rst
@@ -12,7 +12,7 @@ cppmat::diagonal::matrix
 
 Square, diagonal, matrix, whereby only the diagonal components are stored:
 
-.. code-block:: cpp
+.. code-block:: none
 
   [ X       ;
        X    ;
@@ -39,3 +39,14 @@ Square, diagonal, matrix, whereby only the diagonal components are stored:
 
       return 0;
   }
+
+Storage
+-------
+
+The storage order is as follows:
+
+.. code-block:: none
+
+  [ 0       ;
+       1    ;
+          2 ]
diff --git a/docs/cppmat_var_symmetric.rst b/docs/cppmat_var_symmetric.rst
@@ -12,7 +12,7 @@ cppmat::symmetric::matrix
 
 Square, symmetric, matrix, whereby only the upper-diagonal components are stored:
 
-.. code-block:: cpp
+.. code-block:: none
 
   [ X, X, X ;
        X, X ;
@@ -38,3 +38,21 @@ Square, symmetric, matrix, whereby only the upper-diagonal components are stored
 
       return 0;
   }
+
+Storage
+-------
+
+The storage order is as follows:
+
+.. code-block:: none
+
+  [ 0, 1, 2 ;
+       3, 4 ;
+          5 ]
+
+For an ``NxN`` matrix (square by definition), the component ``(i,j)`` can be extracted by
+
+.. code-block:: cpp
+
+  if (i <= j) i*N - (i-1)*i/2 + j - i;
+  else        j*N - (j-1)*j/2 + i - j;