summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorVincent Rouvreau <VincentRouvreau@users.noreply.github.com>2019-06-12 09:35:31 +0200
committerGitHub <noreply@github.com>2019-06-12 09:35:31 +0200
commit8baa5f1026658f53a11e72a12f226c161b36e756 (patch)
treef176c5fd5a4768a4c4c924e389c93f3af422c29e /src
parente058b5eba7a87a6a61cbde08a326002e8cbac967 (diff)
parent27d0f9c592181845e38f85da6a62c6a129b56122 (diff)
Merge pull request #64 from VincentRouvreau/main_documentation_pages
Main documentation pages
Diffstat (limited to 'src')
-rw-r--r--src/common/doc/main_page.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md
index e61eee81..47d0583a 100644
--- a/src/common/doc/main_page.md
+++ b/src/common/doc/main_page.md
@@ -24,7 +24,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref cubical_complex - <b>Reference manual:</b> Gudhi::cubical_complex::Bitmap_cubical_complex
+ <b>User manual:</b> \ref cubical_complex
</td>
</tr>
</table>
@@ -57,8 +57,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref alpha_complex - <b>Reference manual:</b> Gudhi::alpha_complex::Alpha_complex and
- Gudhi::alpha_complex::Alpha_complex_3d
+ <b>User manual:</b> \ref alpha_complex
</td>
</tr>
</table>
@@ -82,7 +81,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref cech_complex - <b>Reference manual:</b> Gudhi::cech_complex::Cech_complex
+ <b>User manual:</b> \ref cech_complex
</td>
</tr>
</table>
@@ -108,7 +107,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref rips_complex - <b>Reference manual:</b> Gudhi::rips_complex::Rips_complex
+ <b>User manual:</b> \ref rips_complex
</td>
</tr>
</table>
@@ -133,7 +132,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref witness_complex - <b>Reference manual:</b> Gudhi::witness_complex::SimplicialComplexForWitness
+ <b>User manual:</b> \ref witness_complex
</td>
</tr>
</table>
@@ -149,7 +148,6 @@
topological information about the input data. They can be computed with a cover of the
data, that comes i.e. from the preimage of a family of intervals covering the image
of a scalar-valued function defined on the data. <br>
- <b>User manual:</b> \ref cover_complex - <b>Reference manual:</b> Gudhi::cover_complex::Cover_complex
</td>
<td width="15%">
<b>Author:</b> Mathieu Carri&egrave;re<br>
@@ -160,7 +158,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref cover_complex - <b>Reference manual:</b> Gudhi::cover_complex::Cover_complex
+ <b>User manual:</b> \ref cover_complex
</td>
</tr>
</table>
@@ -188,7 +186,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref simplex_tree - <b>Reference manual:</b> Gudhi::Simplex_tree
+ <b>User manual:</b> \ref simplex_tree
</td>
</tr>
</table>
@@ -216,7 +214,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref skbl - <b>Reference manual:</b> Gudhi::skeleton_blocker::Skeleton_blocker_complex
+ <b>User manual:</b> \ref skbl
</td>
</tr>
</table>
@@ -241,7 +239,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref toplex_map - <b>Reference manual:</b> Gudhi::Toplex_map
+ <b>User manual:</b> \ref toplex_map
</td>
</tr>
</table>
@@ -301,7 +299,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref persistent_cohomology - <b>Reference manual:</b> Gudhi::persistent_cohomology::Persistent_cohomology
+ <b>User manual:</b> \ref persistent_cohomology
</td>
</tr>
</table>
@@ -331,7 +329,7 @@
</tr>
<tr>
<td colspan=2 height="25">
- <b>User manual:</b> \ref tangential_complex - <b>Reference manual:</b> Gudhi::tangential_complex::Tangential_complex
+ <b>User manual:</b> \ref tangential_complex
</td>
</tr>
</table>
@@ -374,8 +372,8 @@
</td>
<td width="50%">
It contains implementation of various representations of persistence diagrams; diagrams themselves, persistence
- landscapes (rigorous and grid version), persistence heath maps, vectors and others. It implements basic
- functionalities which are neccessary to use persistence in statistics and machine learning.
+ landscapes (rigorous and grid version), persistence heat maps, vectors and others. It implements basic
+ functionalities which are necessary to use persistence in statistics and machine learning.
</td>
<td width="15%">
<b>Author:</b> Pawel Dlotko<br>