diff options
Diffstat (limited to 'src/cython/doc')
| -rw-r--r-- | src/cython/doc/alpha_complex_user.rst | 4 | ||||
| -rw-r--r-- | src/cython/doc/bottleneck_distance_user.rst | 2 | ||||
| -rw-r--r-- | src/cython/doc/installation.rst | 19 | ||||
| -rw-r--r-- | src/cython/doc/rips_complex_user.rst | 8 | ||||
| -rw-r--r-- | src/cython/doc/simplex_tree_user.rst | 34 | ||||
| -rw-r--r-- | src/cython/doc/tangential_complex_user.rst | 2 |
6 files changed, 37 insertions, 32 deletions
diff --git a/src/cython/doc/alpha_complex_user.rst b/src/cython/doc/alpha_complex_user.rst index 68e53a77..2356944d 100644 --- a/src/cython/doc/alpha_complex_user.rst +++ b/src/cython/doc/alpha_complex_user.rst @@ -30,7 +30,7 @@ This example builds the Delaunay triangulation from the given points, and initia repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) The output is: @@ -164,7 +164,7 @@ Then, it is asked to display information about the alpha complex: repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) the program output is: diff --git a/src/cython/doc/bottleneck_distance_user.rst b/src/cython/doc/bottleneck_distance_user.rst index 3bc170f4..8c29d069 100644 --- a/src/cython/doc/bottleneck_distance_user.rst +++ b/src/cython/doc/bottleneck_distance_user.rst @@ -26,7 +26,7 @@ This example computes the bottleneck distance from 2 persistence diagrams: message = "Bottleneck distance approximation=" + repr(gudhi.bottleneck_distance(diag1, diag2, 0.1)) print(message) - message = "Bottleneck distance exact value=" + repr(gudhi.bottleneck_distance(diag1, diag2)) + message = "Bottleneck distance exact value=" + repr(gudhi.bottleneck_distance(diag1, diag2, 0)) print(message) The output is: diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index e7d8c210..f818366b 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -4,12 +4,19 @@ Installation Compiling ********* -The library uses c++11 and requires `Boost <http://www.boost.org/>`_ with version -1.48.0 or more recent. It is a multi-platform library and compiles on Linux, -Mac OSX and Visual Studio 2015. +The library uses c++11 and requires `Boost <http://www.boost.org/>`_ with +version 1.48.0 or more recent. It is a multi-platform library and compiles on +Linux, Mac OSX and Visual Studio 2015. It also requires cmake to generate makefiles, and cython to compile the library. +On `Windows <https://wiki.python.org/moin/WindowsCompilers>`_ , only Python +3.5 and 3.6 are available because of required Visual Studio version. + +On other systems, if you have several Python/cython installed, the version 2.X +will be used by default, but you can force it by adding +:code:`-DPython_ADDITIONAL_VERSIONS=3` to the cmake command. + GUDHI Cythonization =================== @@ -23,8 +30,6 @@ To build the GUDHI cython module, run the following commands in a terminal: cmake .. make cython -A list of examples is available here. - Test suites =========== @@ -33,9 +38,9 @@ following command in a terminal: .. code-block:: bash - cd /path-to-gudhi/build/src/cython + cd /path-to-gudhi/build/cython # For windows, you have to set PYTHONPATH environment variable - export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/src/cython' + export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/cython' py.test Documentation diff --git a/src/cython/doc/rips_complex_user.rst b/src/cython/doc/rips_complex_user.rst index 027c3bf7..c89409a0 100644 --- a/src/cython/doc/rips_complex_user.rst +++ b/src/cython/doc/rips_complex_user.rst @@ -60,7 +60,7 @@ Finally, it is asked to display information about the simplicial complex. repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) When launching (Rips maximal distance between 2 points is 12.0, is expanded @@ -107,7 +107,7 @@ Finally, it is asked to display information about the Rips complex. repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) the program output is: @@ -162,7 +162,7 @@ Finally, it is asked to display information about the simplicial complex. repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) When launching (Rips maximal distance between 2 points is 12.0, is expanded @@ -209,7 +209,7 @@ Finally, it is asked to display information about the Rips complex. repr(simplex_tree.num_simplices()) + ' simplices - ' + \ repr(simplex_tree.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in simplex_tree.get_filtered_tree(): + for filtered_value in simplex_tree.get_filtration(): print(filtered_value) the program output is: diff --git a/src/cython/doc/simplex_tree_user.rst b/src/cython/doc/simplex_tree_user.rst index cbfd34a7..b2efca8b 100644 --- a/src/cython/doc/simplex_tree_user.rst +++ b/src/cython/doc/simplex_tree_user.rst @@ -35,9 +35,9 @@ Example import gudhi st = gudhi.SimplexTree() - if st.insert_simplex([0, 1]): + if st.insert([0, 1]): print("[0, 1] inserted") - if st.insert_simplex_and_subfaces([0, 1, 2], filtration=4.0): + if st.insert([0, 1, 2], filtration=4.0): print("[0, 1, 2] inserted") if st.find([0, 1]): print("[0, 1] found") @@ -45,8 +45,8 @@ Example print(result_str) result_str = 'num_simplices=' + repr(st.num_simplices()) print(result_str) - print("skeleton_tree(2) =") - for sk_value in st.get_skeleton_tree(2): + print("skeleton(2) =") + for sk_value in st.get_skeleton(2): print(sk_value) @@ -54,16 +54,16 @@ The output is: .. testoutput:: - [0, 1] inserted - [0, 1, 2] inserted - [0, 1] found - num_vertices=3 - num_simplices=7 - skeleton_tree(2) = - ([0, 1, 2], 4.0) - ([0, 1], 0.0) - ([0, 2], 4.0) - ([0], 0.0) - ([1, 2], 4.0) - ([1], 4.0) - ([2], 4.0) + [0, 1] inserted + [0, 1, 2] inserted + [0, 1] found + num_vertices=3 + num_simplices=7 + skeleton(2) = + ([0, 1, 2], 4.0) + ([0, 1], 0.0) + ([0, 2], 4.0) + ([0], 0.0) + ([1, 2], 4.0) + ([1], 0.0) + ([2], 4.0) diff --git a/src/cython/doc/tangential_complex_user.rst b/src/cython/doc/tangential_complex_user.rst index 6a7e6e41..24f68f85 100644 --- a/src/cython/doc/tangential_complex_user.rst +++ b/src/cython/doc/tangential_complex_user.rst @@ -133,7 +133,7 @@ This example builds the Tangential complex of point set read in an OFF file. ' - ' + repr(st.num_simplices()) + ' simplices - ' + \ repr(st.num_vertices()) + ' vertices.' print(result_str) - for filtered_value in st.get_filtered_tree(): + for filtered_value in st.get_filtration(): print(filtered_value) The output is: |