summaryrefslogtreecommitdiff
path: root/src/common/utilities/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/utilities/README')
-rw-r--r--src/common/utilities/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/common/utilities/README b/src/common/utilities/README
new file mode 100644
index 00000000..f2ece556
--- /dev/null
+++ b/src/common/utilities/README
@@ -0,0 +1,19 @@
+======================= data_points_generator ==================================
+
+Example of use :
+
+*** Hyper sphere|cube generator
+
+./data_points_generator on sphere onSphere.off 1000 3 15.2
+
+ => generates a onSphere.off file with 1000 points randomized on a sphere of dimension 3 and radius 15.2
+
+./data_points_generator in sphere inSphere.off 100 2
+
+ => generates a inSphere.off file with 100 points randomized in a sphere of dimension 2 (circle) and radius 1.0 (default)
+
+./data_points_generator in cube inCube.off 10000 3 5.8
+
+ => generates a inCube.off file with 10000 points randomized in a cube of dimension 3 and side 5.8
+
+!! Warning: hypegenerator on cube is not available !!