Fix #194 : Rename read_off as it only read points from OFF file

10 files changed, 11 insertions, 10 deletions

diff --git a/src/python/doc/persistence_graphical_tools_user.rst b/src/python/doc/persistence_graphical_tools_user.rst
index f41a926b..80002db6 100644
--- a/src/python/doc/persistence_graphical_tools_user.rst
+++ b/src/python/doc/persistence_graphical_tools_user.rst
@@ -24,7 +24,7 @@ This function can display the persistence result as a barcode:
     import gudhi
 
     off_file = gudhi.__root_source_dir__ + '/data/points/tore3D_300.off'
-    point_cloud = gudhi.read_off(off_file=off_file)
+    point_cloud = gudhi.read_points_from_off_file(off_file=off_file)
 
     rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.7)
     simplex_tree = rips_complex.create_simplex_tree(max_dimension=3)
diff --git a/src/python/doc/reader_utils_ref.rst b/src/python/doc/reader_utils_ref.rst
index f3ecebad..b8977a5a 100644
--- a/src/python/doc/reader_utils_ref.rst
+++ b/src/python/doc/reader_utils_ref.rst
@@ -6,7 +6,7 @@
 Reader utils reference manual
 =============================
 
-.. autofunction:: gudhi.read_off
+.. autofunction:: gudhi.read_points_from_off_file
 
 .. autofunction:: gudhi.read_lower_triangular_matrix_from_csv_file
 
diff --git a/src/python/doc/rips_complex_user.rst b/src/python/doc/rips_complex_user.rst
index a8659542..a27573e8 100644
--- a/src/python/doc/rips_complex_user.rst
+++ b/src/python/doc/rips_complex_user.rst
@@ -136,7 +136,8 @@ Finally, it is asked to display information about the Rips complex.
 .. testcode::
 
     import gudhi
-    point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + '/data/points/alphacomplexdoc.off')
+    off_file = gudhi.__root_source_dir__ + '/data/points/alphacomplexdoc.off'
+    point_cloud = gudhi.read_points_from_off_file(off_file = off_file)
     rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=12.0)
     simplex_tree = rips_complex.create_simplex_tree(max_dimension=1)
     result_str = 'Rips complex is of dimension ' + repr(simplex_tree.dimension()) + ' - ' + \
diff --git a/src/python/doc/witness_complex_user.rst b/src/python/doc/witness_complex_user.rst
index 45ba5b3b..7087fa98 100644
--- a/src/python/doc/witness_complex_user.rst
+++ b/src/python/doc/witness_complex_user.rst
@@ -101,7 +101,7 @@ Let's start with a simple example, which reads an off point file and computes a
             print("#####################################################################")
             print("EuclideanWitnessComplex creation from points read in a OFF file")
 
-            witnesses = gudhi.read_off(off_file=args.file)
+            witnesses = gudhi.read_points_from_off_file(off_file=args.file)
             landmarks = gudhi.pick_n_random_points(points=witnesses, nb_points=args.number_of_landmarks)
 
             message = "EuclideanWitnessComplex with max_edge_length=" + repr(args.max_alpha_square) + \
diff --git a/src/python/example/alpha_rips_persistence_bottleneck_distance.py b/src/python/example/alpha_rips_persistence_bottleneck_distance.py
index 086307ee..d5c33ec8 100755
--- a/src/python/example/alpha_rips_persistence_bottleneck_distance.py
+++ b/src/python/example/alpha_rips_persistence_bottleneck_distance.py
@@ -35,7 +35,7 @@ args = parser.parse_args()
 with open(args.file, "r") as f:
     first_line = f.readline()
     if (first_line == "OFF\n") or (first_line == "nOFF\n"):
-        point_cloud = gudhi.read_off(off_file=args.file)
+        point_cloud = gudhi.read_points_from_off_file(off_file=args.file)
         print("#####################################################################")
         print("RipsComplex creation from points read in a OFF file")
 
diff --git a/src/python/example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py b/src/python/example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py
index 0eedd140..4903667e 100755
--- a/src/python/example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py
+++ b/src/python/example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py
@@ -47,7 +47,7 @@ with open(args.file, "r") as f:
         print("#####################################################################")
         print("EuclideanStrongWitnessComplex creation from points read in a OFF file")
 
-        witnesses = gudhi.read_off(off_file=args.file)
+        witnesses = gudhi.read_points_from_off_file(off_file=args.file)
         landmarks = gudhi.pick_n_random_points(
             points=witnesses, nb_points=args.number_of_landmarks
         )
diff --git a/src/python/example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py b/src/python/example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py
index 1fe55737..339a8577 100755
--- a/src/python/example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py
+++ b/src/python/example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py
@@ -46,7 +46,7 @@ with open(args.file, "r") as f:
         print("#####################################################################")
         print("EuclideanWitnessComplex creation from points read in a OFF file")
 
-        witnesses = gudhi.read_off(off_file=args.file)
+        witnesses = gudhi.read_points_from_off_file(off_file=args.file)
         landmarks = gudhi.pick_n_random_points(
             points=witnesses, nb_points=args.number_of_landmarks
         )
diff --git a/src/python/example/plot_rips_complex.py b/src/python/example/plot_rips_complex.py
index 1c878db1..214a3c0a 100755
--- a/src/python/example/plot_rips_complex.py
+++ b/src/python/example/plot_rips_complex.py
@@ -2,7 +2,7 @@
 
 import numpy as np
 import gudhi
-points = np.array(gudhi.read_off('../../data/points/Kl.off'))
+points = np.array(gudhi.read_points_from_off_file('../../data/points/Kl.off'))
 rc = gudhi.RipsComplex(points=points, max_edge_length=.2)
 st = rc.create_simplex_tree(max_dimension=2)
 # We are only going to plot the triangles
diff --git a/src/python/example/rips_complex_diagram_persistence_from_off_file_example.py b/src/python/example/rips_complex_diagram_persistence_from_off_file_example.py
index b9074cf9..c757aca7 100755
--- a/src/python/example/rips_complex_diagram_persistence_from_off_file_example.py
+++ b/src/python/example/rips_complex_diagram_persistence_from_off_file_example.py
@@ -48,7 +48,7 @@ with open(args.file, "r") as f:
         message = "RipsComplex with max_edge_length=" + repr(args.max_edge_length)
         print(message)
 
-        point_cloud = gudhi.read_off(off_file=args.file)
+        point_cloud = gudhi.read_points_from_off_file(off_file=args.file)
         rips_complex = gudhi.RipsComplex(
             points=point_cloud, max_edge_length=args.max_edge_length
         )
diff --git a/src/python/gudhi/off_reader.pyx b/src/python/gudhi/off_reader.pyx
index 225e981c..ee369976 100644
--- a/src/python/gudhi/off_reader.pyx
+++ b/src/python/gudhi/off_reader.pyx
@@ -19,7 +19,7 @@ __license__ = "MIT"
 cdef extern from "Off_reader_interface.h" namespace "Gudhi":
     vector[vector[double]] read_points_from_OFF_file(string off_file)
 
-def read_off(off_file=''):
+def read_points_from_off_file(off_file=''):
     """Read points from OFF file.
 
     :param off_file: An OFF file style name.