diff options
| author | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-06-17 16:48:14 +0200 |
|---|---|---|
| committer | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-06-17 16:48:14 +0200 |
| commit | 3bfc066548fbdbd9b1dc06b39d8ccecd2ce4d0b5 (patch) | |
| tree | 06c660c08bf83e4daf22039128b48572584812c5 | |
| parent | fc910c1bcb3451bcf3e288db25fecafe15cc42bb (diff) | |
doc review: tuple instead of pair - index is 'm' and not 'n'
| -rw-r--r-- | src/python/gudhi/representations/preprocessing.py | 6 | ||||
| -rw-r--r-- | src/python/gudhi/sklearn/cubical_persistence.py | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/src/python/gudhi/representations/preprocessing.py b/src/python/gudhi/representations/preprocessing.py index bd8c2774..8722e162 100644 --- a/src/python/gudhi/representations/preprocessing.py +++ b/src/python/gudhi/representations/preprocessing.py @@ -402,12 +402,12 @@ class DimensionSelector(BaseEstimator, TransformerMixin): Select persistence diagrams from its dimension. Parameters: - X (list of list of pairs): List of list of persistence pairs, i.e. + X (list of list of tuple): List of list of persistence pairs, i.e. `[[array( Hi(X0) ), array( Hj(X0) ), ...], [array( Hi(X1) ), array( Hj(X1) ), ...], ...]` Returns: - list of pairs: - Persistence diagrams in a specific dimension. i.e. if `index` was set to `m` and `Hn` is at index `n` of + list of tuple: + Persistence diagrams in a specific dimension. i.e. if `index` was set to `m` and `Hn` is at index `m` of the input, it returns `[array( Hn(X0) ), array( Hn(X1), ...]` """ diff --git a/src/python/gudhi/sklearn/cubical_persistence.py b/src/python/gudhi/sklearn/cubical_persistence.py index ed56d2dd..dc7be7f5 100644 --- a/src/python/gudhi/sklearn/cubical_persistence.py +++ b/src/python/gudhi/sklearn/cubical_persistence.py @@ -91,7 +91,7 @@ class CubicalPersistence(BaseEstimator, TransformerMixin): - If `persistence_dimension` was set to `n`: `[array( Hn(X[0]) ), array( Hn(X[1]) ), ...]` - If `persistence_dimension` was set to `[i, j]`: `[[array( Hi(X[0]) ), array( Hj(X[0]) )], [array( Hi(X[1]) ), array( Hj(X[1]) )], ...]` - :rtype: list of pairs or list of list of pairs + :rtype: list of tuple or list of list of tuple """ # Depends on persistence_dimension is an integer or a list of integer (else case) |