diff options
Diffstat (limited to 'src/Witness_complex/include/gudhi/Strong_witness_complex.h')
| -rw-r--r-- | src/Witness_complex/include/gudhi/Strong_witness_complex.h | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h index 164d8ffe..20f9da8d 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -40,18 +40,10 @@ namespace witness_complex { /** * \private * \class Strong_witness_complex - * \brief Constructs strong witness complex for the given sets of witnesses and landmarks. + * \brief Constructs strong witness complex for a given table of nearest landmarks with respect to witnesses. * \ingroup witness_complex * - * \tparam Kernel_ requires a <a target="_blank" - * href="http://doc.cgal.org/latest/Kernel_d/classCGAL_1_1Epick__d.html">CGAL::Epick_d</a> class, which - * can be static if you know the ambiant dimension at compile-time, or dynamic if you don't. - * \tparam DimensionTag can be either <a target="_blank" - * href="http://doc.cgal.org/latest/Kernel_23/classCGAL_1_1Dimension__tag.html">Dimension_tag<d></a> - * if you know the intrinsic dimension at compile-time, - * or <a target="_blank" - * href="http://doc.cgal.org/latest/Kernel_23/classCGAL_1_1Dynamic__dimension__tag.html">CGAL::Dynamic_dimension_tag</a> - * if you don't. + * \tparam Nearest_landmark_table_ needs to be a range of a model of NearestLandmarkRange concept. */ template< class Nearest_landmark_table_ > class Strong_witness_complex { @@ -78,9 +70,8 @@ private: /** * \brief Initializes member variables before constructing simplicial complex. - * \details Records landmarks from the range 'landmarks' into a - * table internally, as well as witnesses from the range 'witnesses'. - * Both ranges should have value_type Kernel_::Point_d. + * \details Records nearest landmark table. + * @param[in] nearest_landmark_table should be a range of a model of NearestLandmarkRange concept. */ Strong_witness_complex(Nearest_landmark_table_ & nearest_landmark_table) : nearest_landmark_table_(nearest_landmark_table) |