Some doc for SimplexTreeOptions.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST-options@745 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 2560e01a832071e13486bfaabfdf166b705d5a70

5 files changed, 58 insertions, 14 deletions

diff --git a/src/Simplex_tree/concept/IndexingTag.h b/src/Simplex_tree/concept/IndexingTag.h
index d690da11..1dcdd756 100644
--- a/src/Simplex_tree/concept/IndexingTag.h
+++ b/src/Simplex_tree/concept/IndexingTag.h
@@ -25,6 +25,6 @@
   * continuous maps to a cell complex, and compute its persistent
   * homology.
   *
-  * Must be linear_indexing_tag. 
+  * Must be `Gudhi::linear_indexing_tag`. 
   */
 struct IndexingTag {};
diff --git a/src/Simplex_tree/concept/SimplexKey.h b/src/Simplex_tree/concept/SimplexKey.h
index ce5b2382..7fdbdd84 100644
--- a/src/Simplex_tree/concept/SimplexKey.h
+++ b/src/Simplex_tree/concept/SimplexKey.h
@@ -22,7 +22,7 @@
 
  /** \brief Key type used as simplex identifier.
   *
-  * Must be <CODE>int</CODE>
+  * Must be a signed integer type.
   */
  struct SimplexKey {};
- 
\ No newline at end of file
+ 
diff --git a/src/Simplex_tree/concept/SimplexTreeOptions.h b/src/Simplex_tree/concept/SimplexTreeOptions.h
new file mode 100644
index 00000000..9415a471
--- /dev/null
+++ b/src/Simplex_tree/concept/SimplexTreeOptions.h
@@ -0,0 +1,41 @@
+ /*    This file is part of the Gudhi Library. The Gudhi library 
+  *    (Geometric Understanding in Higher Dimensions) is a generic C++ 
+  *    library for computational topology.
+  *
+  *    Author(s):       Marc Glisse
+  *
+  *    Copyright (C) 2015  INRIA Saclay - Ile-de-France (France)
+  *
+  *    This program is free software: you can redistribute it and/or modify
+  *    it under the terms of the GNU General Public License as published by
+  *    the Free Software Foundation, either version 3 of the License, or
+  *    (at your option) any later version.
+  *
+  *    This program is distributed in the hope that it will be useful,
+  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  *    GNU General Public License for more details.
+  *
+  *    You should have received a copy of the GNU General Public License
+  *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+  */
+  
+/** \brief Concept of the template parameter for the class `Gudhi::Simplex_tree<SimplexTreeOptions>`.
+ *
+ * One model for this is `Gudhi::Simplex_tree_options_full_featured`. If you want to provide your own, it is recommended that you derive from it and override some parts instead of writing a class from scratch.
+ */
+struct SimplexTreeOptions {
+  /// Forced for now.
+  typedef IndexingTag Indexing_tag;
+  /// Must be a signed integer type. It admits a total order <.
+  typedef VertexHandle Vertex_handle;
+  /// Must be comparable with operator<.
+  typedef FiltrationValue Filtration_value;
+  /// Must be a signed integer type.
+  typedef SimplexKey Simplex_key;
+  /// If true, each simplex has extra storage for one `Simplex_key`. Necessary for `Persistent_cohomology`.
+  static constexpr bool store_key;
+  /// If true, each simplex has extra storage for one `Filtration_value`, and this value is propagated by operations like `Gudhi::Simplex_tree<SimplexTreeOptions>::expansion`. Necessary for `Persistent_cohomology`.
+  static constexpr bool store_filtration;
+};
+
diff --git a/src/Simplex_tree/concept/VertexHandle.h b/src/Simplex_tree/concept/VertexHandle.h
index 491f0f56..3efbba61 100644
--- a/src/Simplex_tree/concept/VertexHandle.h
+++ b/src/Simplex_tree/concept/VertexHandle.h
@@ -22,5 +22,6 @@
   
 /** \brief Handle type for the vertices of a cell complex.
   * 
-  * Must be int.*/
+  * Must be a signed integer type. <code>operator&lt;</code> defines a total order on it.
+  */
 struct VertexHandle {};
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index 11c41d1b..44ee7693 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -74,6 +74,16 @@ namespace Gudhi {
  * @{
  */
 
+/// Model of SimplexTreeOptions.
+struct Simplex_tree_options_full_featured {
+  typedef linear_indexing_tag Indexing_tag;
+  typedef int Vertex_handle;
+  typedef double Filtration_value;
+  typedef int Simplex_key;
+  static constexpr bool store_key = true;
+  static constexpr bool store_filtration = true;
+};
+
 /**
  * \brief Simplex Tree data structure for representing simplicial complexes.
  *
@@ -86,18 +96,10 @@ namespace Gudhi {
  *
  */
 
-struct Simplex_tree_options_full_featured {
-  typedef linear_indexing_tag Indexing_tag;
-  typedef int Vertex_handle;
-  typedef double Filtration_value;
-  typedef int Simplex_key;
-  static constexpr bool store_key = true;
-  static constexpr bool store_filtration = true;
-};
-
-template<typename Options = Simplex_tree_options_full_featured>
+template<typename SimplexTreeOptions = Simplex_tree_options_full_featured>
 class Simplex_tree {
  public:
+  typedef SimplexTreeOptions Options;
   typedef typename Options::Indexing_tag Indexing_tag;
   /** \brief Type for the value of the filtration function.
    *