Add sptenmat (#290)

* Starting with constructors and initial tests * SPTENMAT: * Resolve existing formatting issues * SPTENMAT: * Add typing and test coverage to existing methods * SPTENMAT: * Add remaining methods from MATLAB * SPTENSOR: Fix some formatting around backticks * SPTENMAT: Add automation for inline doc strings * SPTENMAT: Add tutorial * SPTENMAT: Add conversion to sptensor * SPTENMAT: Replace uses of tt_to_sparse_matrix and tt_from_sparse_matrix --------- Co-authored-by: Danny Dunlavy <[email protected]>
sandialabs · Nov 14, 2023 · 5751f02 · 5751f02
1 parent b7bab9b
commit 5751f02
Show file tree

Hide file tree

Showing 9 changed files with 1,253 additions and 117 deletions.
diff --git a/docs/source/sptenmat.rst b/docs/source/sptenmat.rst
@@ -1,2 +1,8 @@
 pyttb.sptenmat
-======================
+----------------------
+
+.. autoclass:: pyttb.sptenmat
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __slots__, __init__
+    :show-inheritance:
diff --git a/docs/source/tensor_classes.rst b/docs/source/tensor_classes.rst
@@ -5,6 +5,7 @@ Tensor Classes
     :maxdepth: 2
 
     ktensor.rst
+    sptenmat.rst
     sptensor.rst
     sumtensor.rst
     tensor.rst