summaryrefslogtreecommitdiff
path: root/src/common/doc
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-12 07:46:27 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-12 07:46:27 +0200
commit6c57ce009e242db0554aaf9316750dd0bb693d6a (patch)
tree94409a8ae609c48a6212ff61a90f7c083e0d8fcf /src/common/doc
parent4e33acbac51c8c2348dc88a16eb38e14c8ef724a (diff)
parentf58f0bb2cb99076d0cd3a11ad39f3277213e3f5e (diff)
Merge branch 'master' into main_documentation_pages
Diffstat (limited to 'src/common/doc')
-rw-r--r--src/common/doc/MathJax.js53
-rw-r--r--src/common/doc/file_formats.h26
-rw-r--r--src/common/doc/installation.h2
3 files changed, 27 insertions, 54 deletions
diff --git a/src/common/doc/MathJax.js b/src/common/doc/MathJax.js
deleted file mode 100644
index 35e1994e..00000000
--- a/src/common/doc/MathJax.js
+++ /dev/null
@@ -1,53 +0,0 @@
-(function () {
- var newMathJax = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js';
- var oldMathJax = 'cdn.mathjax.org/mathjax/latest/MathJax.js';
-
- var replaceScript = function (script, src) {
- //
- // Make redirected script
- //
- var newScript = document.createElement('script');
- newScript.src = newMathJax + src.replace(/.*?(\?|$)/, '$1');
- //
- // Move onload and onerror handlers to new script
- //
- newScript.onload = script.onload;
- newScript.onerror = script.onerror;
- script.onload = script.onerror = null;
- //
- // Move any content (old-style configuration scripts)
- //
- while (script.firstChild) newScript.appendChild(script.firstChild);
- //
- // Copy script id
- //
- if (script.id != null) newScript.id = script.id;
- //
- // Replace original script with new one
- //
- script.parentNode.replaceChild(newScript, script);
- //
- // Issue a console warning
- //
- console.warn('WARNING: cdn.mathjax.org has been retired. Check https://www.mathjax.org/cdn-shutting-down/ for migration tips.')
- }
-
- if (document.currentScript) {
- var script = document.currentScript;
- replaceScript(script, script.src);
- } else {
- //
- // Look for current script by searching for one with the right source
- //
- var n = oldMathJax.length;
- var scripts = document.getElementsByTagName('script');
- for (var i = 0; i < scripts.length; i++) {
- var script = scripts[i];
- var src = (script.src || '').replace(/.*?:\/\//,'');
- if (src.substr(0, n) === oldMathJax) {
- replaceScript(script, src);
- break;
- }
- }
- }
-})(); \ No newline at end of file
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
index 23214e25..235296d3 100644
--- a/src/common/doc/file_formats.h
+++ b/src/common/doc/file_formats.h
@@ -29,6 +29,32 @@ namespace Gudhi {
\tableofcontents
+ \section FileFormatsOFF OFF file format
+
+ OFF files must be conform to format described here: http://www.geomview.org/docs/html/OFF.html
+
+ OFF files are mainly used as point cloud inputs. Here is an example of 7 points in a 3-dimensional space. As edges and
+ faces are not used for point set, there is no need to specify them (just set their numbers to 0):
+
+ \include points/alphacomplexdoc.off
+
+ For dimensions bigger than 3, the dimension can be set like here:
+ \verbatim
+ # Dimension is no more 3
+ nOFF
+ # dimension 4 - 7 vertices - 0 face - 0 edge
+ 4 7 0 0
+ # Point set:
+ 1.0 1.0 0.0 0.0
+ 7.0 0.0 0.0 0.0
+ 4.0 6.0 0.0 0.0
+ 9.0 6.0 0.0 0.0
+ 0.0 14.0 0.0 0.0
+ 2.0 19.0 0.0 0.0
+ 9.0 17.0 0.0 0.0
+ \endverbatim
+
+
\section FileFormatsPers Persistence Diagram
Such a file, whose extension is usually `.pers`, contains a list of persistence intervals.<br>
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h
index 8fb8b330..5d581b08 100644
--- a/src/common/doc/installation.h
+++ b/src/common/doc/installation.h
@@ -44,7 +44,7 @@ make doxygen
\endverbatim
*
* \subsection helloworld Hello world !
- * The <a target="_blank" href="https://gitlab.inria.fr/GUDHI/hello-gudhi-world">Hello world for GUDHI</a>
+ * The <a target="_blank" href="https://github.com/GUDHI/hello-gudhi-world">Hello world for GUDHI</a>
* project is an example to help developers to make their own C++ project on top of the GUDHI library.
*
* \section optionallibrary Optional third-party library