diff options
Diffstat (limited to 'src/Witness_complex/include/gudhi/Active_witness')
| -rw-r--r-- | src/Witness_complex/include/gudhi/Active_witness/Active_witness.h | 3 | ||||
| -rw-r--r-- | src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h | 7 |
2 files changed, 10 insertions, 0 deletions
diff --git a/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h b/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h index 9ae41a69..e52410e4 100644 --- a/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h +++ b/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h @@ -31,6 +31,9 @@ namespace Gudhi { namespace witness_complex { + /** \brief Class representing a list of nearest neighbors to a given witness. + * \detail Every element is a pair of a landmark identifier and the squared distance to it. + */ template< typename Id_distance_pair, typename INS_range > class Active_witness { 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 > |