Moved the doc file + changed notations in Witness_complex.h

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

Former-commit-id: 1053d8ac2f833be8086c81b50dbb34c18de07ebb

2 files changed, 10 insertions, 48 deletions

diff --git a/src/Witness_complex/include/gudhi/Witness_complex.h b/src/Witness_complex/include/gudhi/Witness_complex.h
index 50058740..dab80be6 100644
--- a/src/Witness_complex/include/gudhi/Witness_complex.h
+++ b/src/Witness_complex/include/gudhi/Witness_complex.h
@@ -80,8 +80,8 @@ class Witness_complex {
   typedef std::list< Vertex_handle > ActiveWitnessList;
 
  private:
-  int nbL;  // Number of landmarks
-  SimplicialComplex& sc;  // Simplicial complex
+  int nbL_;  // Number of landmarks
+  SimplicialComplex& sc_;  // Simplicial complex
 
  public:
   /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -108,9 +108,9 @@ class Witness_complex {
    */
   template< typename KNearestNeighbors >
   Witness_complex(KNearestNeighbors const & knn,
-                  int nbL_,
+                  int nbL,
                   int dim,
-                  SimplicialComplex & sc_) : nbL(nbL_), sc(sc_) {
+                  SimplicialComplex & sc) : nbL_(nbL), sc_(sc) {
     // Construction of the active witness list
     int nbW = knn.size();
     typeVectorVertex vv;
@@ -119,12 +119,12 @@ class Witness_complex {
      * it will diminuish in the course of iterations
      */
     ActiveWitnessList active_w;  // = new ActiveWitnessList();
-    for (Vertex_handle i = 0; i != nbL; ++i) {
+    for (Vertex_handle i = 0; i != nbL_; ++i) {
       // initial fill of 0-dimensional simplices
       // by doing it we don't assume that landmarks are necessarily witnesses themselves anymore
       counter++;
       vv = {i};
-      sc.insert_simplex(vv);
+      sc_.insert_simplex(vv);
       // TODO(SK) Error if not inserted : normally no need here though
     }
     int k = 1; /* current dimension in iterative construction */
@@ -139,7 +139,7 @@ class Witness_complex {
         if (ok) {
           for (int i = 0; i != k + 1; ++i)
             simplex_vector.push_back(knn[*it][i]);
-          sc.insert_simplex(simplex_vector);
+          sc_.insert_simplex(simplex_vector);
           // TODO(SK) Error if not inserted : normally no need here though
           it++;
         } else {
@@ -168,7 +168,7 @@ class Witness_complex {
           facet.push_back(knn[witness_id][j]);
         }
       }  // endfor
-      if (sc.find(facet) == sc.null_simplex())
+      if (sc_.find(facet) == sc_.null_simplex())
         return false;
     }  // endfor
     return true;
@@ -196,11 +196,11 @@ class Witness_complex {
   template< class KNearestNeighbors >
   bool is_witness_complex(KNearestNeighbors const & knn, bool print_output) {
     // bool final_result = true;
-    for (Simplex_handle sh : sc.complex_simplex_range()) {
+    for (Simplex_handle sh : sc_.complex_simplex_range()) {
       bool is_witnessed = false;
       typeVectorVertex simplex;
       int nbV = 0;  // number of verticed in the simplex
-      for (Vertex_handle v : sc.simplex_vertex_range(sh))
+      for (Vertex_handle v : sc_.simplex_vertex_range(sh))
         simplex.push_back(v);
       nbV = simplex.size();
       for (typeVectorVertex w : knn) {
diff --git a/src/Witness_complex/include/gudhi/Witness_complex_doc.h b/src/Witness_complex/include/gudhi/Witness_complex_doc.h
deleted file mode 100644
index e9f78170..00000000
--- a/src/Witness_complex/include/gudhi/Witness_complex_doc.h
+++ /dev/null
@@ -1,38 +0,0 @@
-#ifndef WITNESS_COMPLEX_DOC_H_
-#define WITNESS_COMPLEX_DOC_H_
-
-/**
-   \defgroup witness_complex Witness complex
-
-   \author Siargey Kachanovich
-
-   \section Definitions
-
-   Witness complex \f$ Wit(W,L) \f$  is a simplicial complex defined on two sets of points in \f$\mathbb{R}^D\f$:
-
-   \li \f$W\f$ set of **witnesses** and 
-   \li \f$L \subseteq W\f$ set of **landmarks**.
-
-   The simplices are based on landmarks
-   and a simplex belongs to the witness complex if and only if it is witnessed, that is:
-
-   \f$ \sigma \subset L \f$ is witnessed if there exists a point \f$w \in W\f$ such that 
-   w is closer to the vertices of \f$ \sigma \f$ than other points in \f$ L \f$ and all of its faces are witnessed as well. 
-      
-   \section Implementation
-
-   The principal class of this module is Gudhi::Witness_complex.
-
-   In both cases, the constructor for this class takes a {witness}x{closest_landmarks} table, where each row represents a witness and consists of landmarks sorted by distance to this witness.
-   This table can be constructed by two additional classes Landmark_choice_by_furthest_point and Landmark_choice_by_random_point also included in the module.
-
-   *\image html "bench_Cy8.png" "Running time as function on number of landmarks" width=10cm
-   *\image html "bench_sphere.png" "Running time as function on number of witnesses for |L|=300" width=10cm
-   
-
-   \copyright GNU General Public License v3.
-
-
- */
-
-#endif  // WITNESS_COMPLEX_DOC_H_