summaryrefslogtreecommitdiff
path: root/src/cython/doc/witness_complex_user.rst
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-08-12 15:29:48 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-08-12 15:29:48 +0000
commit5b6bebd9a8072d8998b0c741e5b40de0cfe5dc8e (patch)
tree995194307af2d09f44dcdd9fd1494f3ada6e966a /src/cython/doc/witness_complex_user.rst
parent46566db4452be7dee8398e1ed5a25add7f80ac39 (diff)
Move cython/src/* in cython/
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@1436 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 8f971ef16ef6df597d5d3667db0eecbca94233b2
Diffstat (limited to 'src/cython/doc/witness_complex_user.rst')
-rw-r--r--src/cython/doc/witness_complex_user.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/cython/doc/witness_complex_user.rst b/src/cython/doc/witness_complex_user.rst
new file mode 100644
index 00000000..604c7357
--- /dev/null
+++ b/src/cython/doc/witness_complex_user.rst
@@ -0,0 +1,31 @@
+===========================
+Witness complex user manual
+===========================
+Definition
+----------
+
+.. include:: witness_complex_sum.rst
+
+Implementation
+--------------
+
+The principal class of this module is Gudhi::Witness_complex.
+
+In both cases, the constructor for this class takes a {witness}x{closest_landmarks} table, where each row represents a
+witness and consists of landmarks sorted by distance to this witness.
+
+.. todo::
+ This table can be constructed by two additional classes Landmark_choice_by_furthest_point and
+ Landmark_choice_by_random_point also included in the module.
+
+.. figure::
+ img/bench_Cy8.png
+ :align: center
+
+ Running time as function on number of landmarks.
+
+.. figure::
+ img/bench_sphere.png
+ :align: center
+
+ Running time as function on number of witnesses for |L|=300.