summaryrefslogtreecommitdiff
path: root/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h')
-rw-r--r--src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h b/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h
index 5d4f3d75..9c96f7e8 100644
--- a/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h
+++ b/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h
@@ -31,6 +31,13 @@ namespace Gudhi {
namespace witness_complex {
+ /** \brief Iterator in the nearest landmark list.
+ * \detail After the iterator reaches the end of the list,
+ * the list is augmented by a (nearest landmark, distance) pair if possible.
+ * If all the landmarks are present in the list, iterator returns the specific end value
+ * of the corresponding 'Active_witness' object.
+ */
+
template< typename Active_witness,
typename Id_distance_pair,
typename INS_iterator >