From bdb5bb5bb9af58e4e61acae13ea1c35b52bde2e7 Mon Sep 17 00:00:00 2001
From: Gard Spreemann <gspreemann@gmail.com>
Date: Wed, 30 Mar 2016 15:09:27 +0200
Subject: Some documentation for general simplicial complexes.

---
 phstuff/diphawrapper.py | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

(limited to 'phstuff')

diff --git a/phstuff/diphawrapper.py b/phstuff/diphawrapper.py
index b2c9444..4d1742e 100644
--- a/phstuff/diphawrapper.py
+++ b/phstuff/diphawrapper.py
@@ -187,6 +187,19 @@ def save_cubical(fname, array):
             f.write(struct.pack("<d", float(w)))
 
 def save_simplicial(fname, complex):
+    """*EXPERIMENTAL*. Save a filtered simplicial complex.
+
+    Corresponds to DIPHA's "weighted boundary matrix".
+
+    Parameters:
+    -----------
+    
+    fname: Name of file to write.
+
+    complex: Simplicial complex to save.
+
+    """
+        
     complex.order()
     assert(complex.is_ordered())
     
@@ -221,10 +234,6 @@ def save_simplicial(fname, complex):
                 f.write(struct.pack("<q", bnode.i))
             
             
-    
-    
-            
-
 def load_barcode(fname, top_dim = None):
 
     """Load a barcode as written by DIPHA.
-- 
cgit v1.2.3