author Dmitriy Morozov Thu, 10 May 2012 15:52:53 -0700 branch dev changeset 249 0c5c45ebbf97 parent 248 45589223382c child 250 021030a8f97c
Added a note about wasserstein_distance() to documentation + cleaned up docs for init_diagrams()
```--- a/doc/python/persistence-diagram.rst	Thu May 10 15:46:52 2012 -0700
+++ b/doc/python/persistence-diagram.rst	Thu May 10 15:52:53 2012 -0700
@@ -46,11 +46,11 @@

.. function:: init_diagrams(persistence, filtration[, eval = lambda s: s.data[, data = lambda i: None]])

-    Initializes a collection of :class:`PersistenceDiagram`s from `persistence`
+    Initializes a collection of :class:`PersistenceDiagram` instances from `persistence`
and `filtration`. Optional `eval` can determine how to extract birth and
death values from a simplex. For example, if `filtration` was filled using
-    :fun:`fill_alpha_complex()`, the :attr:`~Simplex.data` contains a pair ``(value, critical)``.
-    We can extract the value from the tuple::
+    :func:`fill_alpha_complex()`, the :attr:`~Simplex.data` contains a pair ``(value, critical)``.
+    We can extract the ``value`` from the tuple::

init_diagrams(persistence, filtration, lambda s: s.data)

@@ -60,3 +60,8 @@
.. function:: bottleneck_distance(dia1, dia2)

Calculates the bottleneck distance between the two persistence diagrams.
+
+.. function:: wasserstein_distance(dia1, dia2, p)
+
+    Calculates the `p`-th Wasserstein distance between the two persistence diagrams.
+```