Overlay for non-basic matrices replacing all input and output MatIdx indices of the original methods with IDIdx indices. More...
#include <gudhi/Persistence_matrix/Id_to_index_overlay.h>
Public Types | |
using | Index = typename Master_matrix::Index |
using | ID_index = typename Master_matrix::ID_index |
using | Pos_index = typename Master_matrix::Pos_index |
using | Dimension = typename Master_matrix::Dimension |
using | Field_operators = typename Master_matrix::Field_operators |
Field operators class. Necessary only if PersistenceMatrixOptions::is_z2 is false. | |
using | Field_element = typename Master_matrix::Element |
using | Boundary = typename Master_matrix::Boundary |
using | Column = typename Master_matrix::Column |
using | Row = typename Master_matrix::Row |
using | Bar = typename Master_matrix::Bar |
using | Barcode = typename Master_matrix::Barcode |
using | Cycle = typename Master_matrix::Cycle |
using | Entry_constructor = typename Master_matrix::Entry_constructor |
using | Column_settings = typename Master_matrix::Column_settings |
Public Member Functions | |
Id_to_index_overlay (Column_settings *colSettings) | |
Constructs an empty matrix. More... | |
template<class Boundary_range = Boundary> | |
Id_to_index_overlay (const std::vector< Boundary_range > &orderedBoundaries, Column_settings *colSettings) | |
Constructs a new matrix from the given ranges of Matrix::Entry_representative. Each range corresponds to a column (the order of the ranges are preserved). The content of the ranges is assumed to be sorted by increasing IDs. The IDs of the simplices are also assumed to be consecutive, ordered by filtration value, starting with 0. More... | |
Id_to_index_overlay (unsigned int numberOfColumns, Column_settings *colSettings) | |
Constructs a new empty matrix and reserves space for the given number of columns. More... | |
template<typename BirthComparatorFunction , typename DeathComparatorFunction > | |
Id_to_index_overlay (Column_settings *colSettings, const BirthComparatorFunction &birthComparator, const DeathComparatorFunction &deathComparator) | |
Only available for chain matrices. Constructs an empty matrix and stores the given comparators. More... | |
template<typename BirthComparatorFunction , typename DeathComparatorFunction , class Boundary_range > | |
Id_to_index_overlay (const std::vector< Boundary_range > &orderedBoundaries, Column_settings *colSettings, const BirthComparatorFunction &birthComparator, const DeathComparatorFunction &deathComparator) | |
Only available for chain matrices. Constructs a new matrix from the given ranges of Matrix::Entry_representative. Each range corresponds to a column (the order of the ranges are preserved). The content of the ranges is assumed to be sorted by increasing IDs. The IDs of the simplices are also assumed to be consecutive, ordered by filtration value, starting with 0. More... | |
template<typename BirthComparatorFunction , typename DeathComparatorFunction > | |
Id_to_index_overlay (unsigned int numberOfColumns, Column_settings *colSettings, const BirthComparatorFunction &birthComparator, const DeathComparatorFunction &deathComparator) | |
Only available for chain matrices. Constructs a new empty matrix and reserves space for the given number of columns. More... | |
Id_to_index_overlay (const Id_to_index_overlay &matrixToCopy, Column_settings *colSettings=nullptr) | |
Copy constructor. If operators or entryConstructor is not a null pointer, its value is kept instead of the one in the copied matrix. More... | |
Id_to_index_overlay (Id_to_index_overlay &&other) noexcept | |
Move constructor. More... | |
~Id_to_index_overlay () | |
Destructor. | |
template<class Boundary_range = Boundary> | |
void | insert_boundary (const Boundary_range &boundary, Dimension dim=Master_matrix::template get_null_value< Dimension >()) |
Inserts at the end of the matrix a new ordered column corresponding to the given boundary. This means that it is assumed that this method is called on boundaries in the order of the filtration. It also assumes that the cells in the given boundary are identified by their relative position in the filtration, starting at 0. If it is not the case, use the other insert_boundary instead by indicating the cell ID used in the boundaries when the cell is inserted. More... | |
template<class Boundary_range = Boundary> | |
void | insert_boundary (ID_index cellIndex, const Boundary_range &boundary, Dimension dim=Master_matrix::template get_null_value< Dimension >()) |
It does the same as the other version, but allows the boundary cells to be identified without restrictions except that all IDs have to be strictly increasing in the order of filtration. Note that you should avoid then to use the other insertion method to avoid overwriting IDs. More... | |
Column & | get_column (ID_index cellID) |
Returns the column at the given IDIdx index. For RU matrices, the returned column is from \( R \). The type of the column depends on the chosen options, see PersistenceMatrixOptions::column_type. More... | |
Row & | get_row (ID_index rowIndex) |
Only available if PersistenceMatrixOptions::has_row_access is true. Returns the row at the given row index. For RU matrices, the returned row is from \( R \). The type of the row depends on the chosen options, see PersistenceMatrixOptions::has_intrusive_rows. More... | |
void | erase_empty_row (ID_index rowIndex) |
The effect varies depending on the matrices and the options: More... | |
void | remove_maximal_cell (ID_index cellID) |
Only available for RU and chain matrices and if PersistenceMatrixOptions::has_removable_columns and PersistenceMatrixOptions::has_vine_update are true. For chain matrices, PersistenceMatrixOptions::has_map_column_container and PersistenceMatrixOptions::has_column_pairings also need to be true. Assumes that the cell is maximal in the current complex and removes it such that the matrix remains consistent (i.e., RU is still an upper triangular decomposition of the boundary matrix and chain is still a compatible bases of the chain complex in the sense of [41]). The maximality of the cell is not verified. Also updates the barcode if it was computed. More... | |
void | remove_maximal_cell (ID_index cellID, const std::vector< ID_index > &columnsToSwap) |
Only available for chain matrices and if PersistenceMatrixOptions::has_removable_columns, PersistenceMatrixOptions::has_vine_update and PersistenceMatrixOptions::has_map_column_container are true. Assumes that the cell is maximal in the current complex and removes it such that the matrix remains consistent (i.e., it is still a compatible bases of the chain complex in the sense of [41]). The maximality of the cell is not verified. Also updates the barcode if it was computed. More... | |
void | remove_last () |
Only available if PersistenceMatrixOptions::has_removable_columns is true. Additionally, if the matrix is a chain matrix, either PersistenceMatrixOptions::has_map_column_container has to be true or PersistenceMatrixOptions::has_vine_update has to be false. Removes the last cell in the filtration from the matrix and updates the barcode if it is stored. More... | |
Dimension | get_max_dimension () const |
Returns the maximal dimension of a cell stored in the matrix. Only available if PersistenceMatrixOptions::has_matrix_maximal_dimension_access is true. More... | |
Index | get_number_of_columns () const |
Returns the current number of columns in the matrix. More... | |
Dimension | get_column_dimension (ID_index cellID) const |
Returns the dimension of the given cell. Only available for non-basic matrices. More... | |
void | add_to (ID_index sourceCellID, ID_index targetCellID) |
Adds column corresponding to sourceCellID onto the column corresponding to targetCellID . More... | |
void | multiply_target_and_add_to (ID_index sourceCellID, const Field_element &coefficient, ID_index targetCellID) |
Multiplies the target column with the coefficient and then adds the source column to it. That is: targetColumn = (targetColumn * coefficient) + sourceColumn . More... | |
void | multiply_source_and_add_to (const Field_element &coefficient, ID_index sourceCellID, ID_index targetCellID) |
Multiplies the source column with the coefficient before adding it to the target column. That is: targetColumn += (coefficient * sourceColumn) . The source column will not be modified. More... | |
void | zero_entry (ID_index cellID, ID_index rowIndex) |
Zeroes the entry at the given coordinates. Not available for chain matrices. In general, should be used with care to not destroy the validity of the persistence related properties of the matrix. More... | |
void | zero_column (ID_index cellID) |
Zeroes the column at the given index. Not available for chain matrices. In general, should be used with care to not destroy the validity of the persistence related properties of the matrix. More... | |
bool | is_zero_entry (ID_index cellID, ID_index rowIndex) const |
Indicates if the entry at given coordinates has value zero. More... | |
bool | is_zero_column (ID_index cellID) |
Indicates if the column at given index has value zero. More... | |
ID_index | get_column_with_pivot (ID_index cellIndex) const |
Returns the IDIdx index of the column which has the given row index as pivot. Assumes that the pivot exists. For RU matrices, the column is returned from \( R \). More... | |
ID_index | get_pivot (ID_index cellID) |
Returns the row index of the pivot of the given column. More... | |
void | reset (Column_settings *colSettings) |
Resets the matrix to an empty matrix. More... | |
Id_to_index_overlay & | operator= (const Id_to_index_overlay &other) |
Assign operator. | |
const Barcode & | get_current_barcode () |
Returns the current barcode of the matrix. Available only if PersistenceMatrixOptions::has_column_pairings is true. More... | |
void | swap_columns (ID_index cellID1, ID_index cellID2) |
Only available for simple boundary matrices (only storing \( R \)) and if PersistenceMatrixOptions::has_column_and_row_swaps is true. Swaps the two given columns. Note that it really just swaps two columns and do not updates anything else, nor performs additions to maintain some properties on the matrix. More... | |
void | swap_rows (Index rowIndex1, Index rowIndex2) |
Only available for simple boundary matrices (only storing R) and if PersistenceMatrixOptions::has_column_and_row_swaps is true. Swaps the two given rows. Note that it really just swaps two rows and do not updates anything else, nor performs additions to maintain some properties on the matrix. More... | |
ID_index | vine_swap_with_z_eq_1_case (ID_index cellID1, ID_index cellID2) |
Only available if PersistenceMatrixOptions::has_vine_update is true. Does the same than vine_swap, but assumes that the swap is non trivial and therefore skips a part of the case study. More... | |
ID_index | vine_swap (ID_index cellID1, ID_index cellID2) |
Only available if PersistenceMatrixOptions::has_vine_update is true. Does a vine swap between two cells which are consecutive in the filtration. Roughly, if \( F \) is the current filtration represented by the matrix, the method modifies the matrix such that the new state corresponds to a valid state for the filtration \( F' \) equal to \( F \) but with the two given cells at swapped positions. Of course, the two cells should not have a face/coface relation which each other ; \( F' \) has to be a valid filtration. See [21] for more information about vine and vineyards. More... | |
void | update_representative_cycles () |
Only available if PersistenceMatrixOptions::can_retrieve_representative_cycles is true. Pre-computes the representative cycles of the current state of the filtration represented by the matrix. It does not need to be called before get_representative_cycles is called for the first time, but needs to be called before calling get_representative_cycles again if the matrix was modified in between. Otherwise the old cycles will be returned. | |
const std::vector< Cycle > & | get_representative_cycles () |
Only available if PersistenceMatrixOptions::can_retrieve_representative_cycles is true. Returns all representative cycles of the current filtration. More... | |
const Cycle & | get_representative_cycle (const Bar &bar) |
Only available if PersistenceMatrixOptions::can_retrieve_representative_cycles is true. Returns the cycle representing the given bar. More... | |
Friends | |
void | swap (Id_to_index_overlay &matrix1, Id_to_index_overlay &matrix2) |
Swap operator. | |
Overlay for non-basic matrices replacing all input and output MatIdx indices of the original methods with IDIdx indices.
Underlying_matrix | Matrix type taking the overlay. |
Master_matrix | An instantiation of Matrix from which all types and options are deduced. |
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Bar = typename Master_matrix::Bar |
Bar type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Barcode = typename Master_matrix::Barcode |
Barcode type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Boundary = typename Master_matrix::Boundary |
Type of an input column.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Column = typename Master_matrix::Column |
Column type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Column_settings = typename Master_matrix::Column_settings |
Structure giving access to the columns to necessary external classes.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Cycle = typename Master_matrix::Cycle |
Cycle type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Dimension = typename Master_matrix::Dimension |
Dimension value type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Entry_constructor = typename Master_matrix::Entry_constructor |
Factory of Entry classes.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Field_element = typename Master_matrix::Element |
Type of an field element.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::ID_index = typename Master_matrix::ID_index |
IDIdx index type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Index = typename Master_matrix::Index |
MatIdx index type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Pos_index = typename Master_matrix::Pos_index |
PosIdx index type.
using Gudhi::persistence_matrix::Id_to_index_overlay< Underlying_matrix, Master_matrix >::Row = typename Master_matrix::Row |
Row type, only necessary with row access option.
|
inline |
Constructs an empty matrix.
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
|
inline |
Constructs a new matrix from the given ranges of Matrix::Entry_representative. Each range corresponds to a column (the order of the ranges are preserved). The content of the ranges is assumed to be sorted by increasing IDs. The IDs of the simplices are also assumed to be consecutive, ordered by filtration value, starting with 0.
Boundary_range | Range type for Matrix::Entry_representative ranges. Assumed to have a begin(), end() and size() method. |
orderedBoundaries | Range of boundaries: orderedBoundaries is interpreted as a boundary matrix of a filtered simplicial complex, whose boundaries are ordered by filtration order. Therefore, orderedBoundaries[i] should store the boundary of the \( i^{th} \) simplex in the filtration, as an ordered list of indices of its facets (again those indices correspond to their respective position in the matrix). That is why the indices of the simplices are assumed to be consecutive and starting with 0 (an empty boundary is interpreted as a vertex boundary and not as a non existing simplex). All dimensions up to the maximal dimension of interest have to be present. If only a higher dimension is of interest and not everything should be stored, then use the insert_boundary method instead (after creating the matrix with the Id_to_index_overlay(unsigned int, Column_settings*) constructor preferably). |
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
|
inline |
Constructs a new empty matrix and reserves space for the given number of columns.
numberOfColumns | Number of columns to reserve space for. |
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
|
inline |
Only available for chain matrices. Constructs an empty matrix and stores the given comparators.
BirthComparatorFunction | Type of the birth comparator: (Pos_index, Pos_index) -> bool |
DeathComparatorFunction | Type of the death comparator: (Pos_index, Pos_index) -> bool |
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
birthComparator | Method taking two PosIdx indices as input and returning true if and only if the birth associated to the first position is strictly less than birth associated to the second one with respect to some self defined order. It is used while swapping two unpaired or two negative columns. |
deathComparator | Method taking two PosIdx indices as input and returning true if and only if the death associated to the first position is strictly less than death associated to the second one with respect to some self defined order. It is used while swapping two positive but paired columns. |
|
inline |
Only available for chain matrices. Constructs a new matrix from the given ranges of Matrix::Entry_representative. Each range corresponds to a column (the order of the ranges are preserved). The content of the ranges is assumed to be sorted by increasing IDs. The IDs of the simplices are also assumed to be consecutive, ordered by filtration value, starting with 0.
BirthComparatorFunction | Type of the birth comparator: (Pos_index, Pos_index) -> bool |
DeathComparatorFunction | Type of the death comparator: (Pos_index, Pos_index) -> bool |
Boundary_range | Range type for Matrix::Entry_representative ranges. Assumed to have a begin(), end() and size() method. |
orderedBoundaries | Range of boundaries: orderedBoundaries is interpreted as a boundary matrix of a filtered simplicial complex, whose boundaries are ordered by filtration order. Therefore, orderedBoundaries[i] should store the boundary of the \( i^{th} \) simplex in the filtration, as an ordered list of indices of its facets (again those indices correspond to their respective position in the matrix). That is why the indices of the simplices are assumed to be consecutive and starting with 0 (an empty boundary is interpreted as a vertex boundary and not as a non existing simplex). All dimensions up to the maximal dimension of interest have to be present. If only a higher dimension is of interest and not everything should be stored, then use the insert_boundary method instead (after creating the matrix with the Id_to_index_overlay(unsigned int, Column_settings*,
const BirthComparatorFunction&, const DeathComparatorFunction&) constructor preferably). |
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
birthComparator | Method taking two PosIdx indices as input and returning true if and only if the birth associated to the first position is strictly less than birth associated to the second one with respect to some self defined order. It is used while swapping two unpaired or two negative columns. |
deathComparator | Method taking two PosIdx indices as input and returning true if and only if the death associated to the first position is strictly less than death associated to the second one with respect to some self defined order. It is used while swapping two positive but paired columns. |
|
inline |
Only available for chain matrices. Constructs a new empty matrix and reserves space for the given number of columns.
BirthComparatorFunction | Type of the birth comparator: (Pos_index, Pos_index) -> bool |
DeathComparatorFunction | Type of the death comparator: (Pos_index, Pos_index) -> bool |
numberOfColumns | Number of columns to reserve space for. |
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
birthComparator | Method taking two PosIdx indices as input and returning true if and only if the birth associated to the first position is strictly less than birth associated to the second one with respect to some self defined order. It is used while swapping two unpaired or two negative columns. |
deathComparator | Method taking two PosIdx indices as input and returning true if and only if the death associated to the first position is strictly less than death associated to the second one with respect to some self defined order. It is used while swapping two positive but paired columns. |
|
inline |
Copy constructor. If operators
or entryConstructor
is not a null pointer, its value is kept instead of the one in the copied matrix.
matrixToCopy | Matrix to copy. |
colSettings | Either a pointer to an existing setting structure for the columns or a null pointer. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. If null pointer, the pointer stored in matrixToCopy is used instead. |
|
inlinenoexcept |
Move constructor.
other | Matrix to move. |
|
inline |
Adds column corresponding to sourceCellID
onto the column corresponding to targetCellID
.
|
inline |
The effect varies depending on the matrices and the options:
rowIndex | Row index of the empty row to remove. |
|
inline |
Returns the column at the given IDIdx index. For RU matrices, the returned column is from \( R \). The type of the column depends on the chosen options, see PersistenceMatrixOptions::column_type.
cellID | IDIdx index of the column to return. |
|
inline |
Returns the dimension of the given cell. Only available for non-basic matrices.
cellID | IDIdx index of the cell. |
|
inline |
Returns the IDIdx index of the column which has the given row index as pivot. Assumes that the pivot exists. For RU matrices, the column is returned from \( R \).
Recall that the row indices for chain matrices correspond to the IDIdx indices and that the row indices for a RU matrix correspond to the updated IDIdx indices which got potentially swapped by a vine swap.
cellIndex | Row index of the pivot. |
|
inline |
Returns the current barcode of the matrix. Available only if PersistenceMatrixOptions::has_column_pairings is true.
Recall that we assume that the boundaries were inserted in the order of filtration for the barcode to be valid.
|
inline |
Returns the maximal dimension of a cell stored in the matrix. Only available if PersistenceMatrixOptions::has_matrix_maximal_dimension_access is true.
|
inline |
Returns the current number of columns in the matrix.
|
inline |
|
inline |
Only available if PersistenceMatrixOptions::can_retrieve_representative_cycles is true. Returns the cycle representing the given bar.
bar | A bar from the current barcode. |
bar
.
|
inline |
Only available if PersistenceMatrixOptions::can_retrieve_representative_cycles is true. Returns all representative cycles of the current filtration.
|
inline |
Only available if PersistenceMatrixOptions::has_row_access is true. Returns the row at the given row index. For RU matrices, the returned row is from \( R \). The type of the row depends on the chosen options, see PersistenceMatrixOptions::has_intrusive_rows.
rowIndex | Row index of the row to return: IDIdx for chain matrices or updated IDIdx for boundary matrices if swaps occurred. |
|
inline |
Inserts at the end of the matrix a new ordered column corresponding to the given boundary. This means that it is assumed that this method is called on boundaries in the order of the filtration. It also assumes that the cells in the given boundary are identified by their relative position in the filtration, starting at 0. If it is not the case, use the other insert_boundary instead by indicating the cell ID used in the boundaries when the cell is inserted.
Different to the constructor, the boundaries do not have to come from a simplicial complex, but also from a more general entry complex. This includes cubical complexes or Morse complexes for example.
The content of the new column will vary depending on the underlying type of the matrix:
IDIdx + linear combination of older column IDIdxs
, where the combination is deduced while reducing the given boundary. If the barcode is stored, it will also be updated.Boundary_range | Range of Matrix::Entry_representative. Assumed to have a begin(), end() and size() method. |
boundary | Boundary generating the new column. The content should be ordered by ID. |
dim | Dimension of the cell whose boundary is given. If the complex is simplicial, this parameter can be omitted as it can be deduced from the size of the boundary. |
|
inline |
It does the same as the other version, but allows the boundary cells to be identified without restrictions except that all IDs have to be strictly increasing in the order of filtration. Note that you should avoid then to use the other insertion method to avoid overwriting IDs.
As a cell has to be inserted before one of its cofaces in a valid filtration (recall that it is assumed that the cells are inserted by order of filtration), it is sufficient to indicate the ID of the cell being inserted.
Boundary_range | Range of Matrix::Entry_representative. Assumed to have a begin(), end() and size() method. |
cellIndex | IDIdx index to use to identify the new cell. |
boundary | Boundary generating the new column. The indices of the boundary have to correspond to the cellIndex values of precedent calls of the method for the corresponding cells and should be ordered in increasing order. |
dim | Dimension of the cell whose boundary is given. If the complex is simplicial, this parameter can be omitted as it can be deduced from the size of the boundary. |
|
inline |
Indicates if the column at given index has value zero.
For RU matrices, looks into \( R \).
Note that for chain matrices, this method should always return false, as a valid chain matrix never has empty columns.
cellID | IDIdx index of the cell corresponding to the column. |
|
inline |
Indicates if the entry at given coordinates has value zero.
For RU matrices, looks into \( R \).
cellID | IDIdx index of the cell corresponding to the column of the entry. |
rowIndex | Row index of the row of the entry. |
|
inline |
Multiplies the source column with the coefficient before adding it to the target column. That is: targetColumn += (coefficient * sourceColumn)
. The source column will not be modified.
|
inline |
Multiplies the target column with the coefficient and then adds the source column to it. That is: targetColumn = (targetColumn * coefficient) + sourceColumn
.
|
inline |
Only available if PersistenceMatrixOptions::has_removable_columns is true. Additionally, if the matrix is a chain matrix, either PersistenceMatrixOptions::has_map_column_container has to be true or PersistenceMatrixOptions::has_vine_update has to be false. Removes the last cell in the filtration from the matrix and updates the barcode if it is stored.
See also remove_maximal_cell.
For chain matrices, if PersistenceMatrixOptions::has_vine_update is true, the last cell does not have to be at the end of the matrix and therefore has to be searched first. In this case, if the user already knows the IDIdx of the last cell, calling remove_maximal_cell(cellID, {}) instead allows to skip the search.
|
inline |
Only available for RU and chain matrices and if PersistenceMatrixOptions::has_removable_columns and PersistenceMatrixOptions::has_vine_update are true. For chain matrices, PersistenceMatrixOptions::has_map_column_container and PersistenceMatrixOptions::has_column_pairings also need to be true. Assumes that the cell is maximal in the current complex and removes it such that the matrix remains consistent (i.e., RU is still an upper triangular decomposition of the boundary matrix and chain is still a compatible bases of the chain complex in the sense of [41]). The maximality of the cell is not verified. Also updates the barcode if it was computed.
For chain matrices, using the other version of the method could perform better depending on how the data is maintained on the side of the user. Then, PersistenceMatrixOptions::has_column_pairings also do not need to be true.
See also remove_last.
cellID | IDIdx index of the cell to remove. |
|
inline |
Only available for chain matrices and if PersistenceMatrixOptions::has_removable_columns, PersistenceMatrixOptions::has_vine_update and PersistenceMatrixOptions::has_map_column_container are true. Assumes that the cell is maximal in the current complex and removes it such that the matrix remains consistent (i.e., it is still a compatible bases of the chain complex in the sense of [41]). The maximality of the cell is not verified. Also updates the barcode if it was computed.
To maintain the compatibility, vine swaps are done to move the cell up to the end of the filtration. Once at the end, the removal is trivial. But for chain matrices, swaps do not actually swap the position of the column every time, so the cells appearing after cellIndex
in the filtration have to be searched first within the matrix. If the user has an easy access to the IDIdx of the cells in the order of filtration, passing them by argument with columnsToSwap
allows to skip a linear search process. Typically, if the user knows that the cell he wants to remove is already the last cell of the filtration, calling remove_maximal_cell(cellID, {}) will be faster than remove_last().
See also remove_last.
|
inline |
Resets the matrix to an empty matrix.
colSettings | Pointer to an existing setting structure for the columns. The structure should contain all the necessary external classes specifically necessary for the chosen column type, such as custom allocators. |
|
inline |
Only available for simple boundary matrices (only storing \( R \)) and if PersistenceMatrixOptions::has_column_and_row_swaps is true. Swaps the two given columns. Note that it really just swaps two columns and do not updates anything else, nor performs additions to maintain some properties on the matrix.
|
inline |
Only available for simple boundary matrices (only storing R) and if PersistenceMatrixOptions::has_column_and_row_swaps is true. Swaps the two given rows. Note that it really just swaps two rows and do not updates anything else, nor performs additions to maintain some properties on the matrix.
|
inline |
Only available if PersistenceMatrixOptions::has_vine_update is true. Does a vine swap between two cells which are consecutive in the filtration. Roughly, if \( F \) is the current filtration represented by the matrix, the method modifies the matrix such that the new state corresponds to a valid state for the filtration \( F' \) equal to \( F \) but with the two given cells at swapped positions. Of course, the two cells should not have a face/coface relation which each other ; \( F' \) has to be a valid filtration. See [21] for more information about vine and vineyards.
|
inline |
Only available if PersistenceMatrixOptions::has_vine_update is true. Does the same than vine_swap, but assumes that the swap is non trivial and therefore skips a part of the case study.
|
inline |
Zeroes the column at the given index. Not available for chain matrices. In general, should be used with care to not destroy the validity of the persistence related properties of the matrix.
For RU matrices, zeros only the column in \( R \).
cellID | IDIdx index of the cell corresponding to the column. |
|
inline |
Zeroes the entry at the given coordinates. Not available for chain matrices. In general, should be used with care to not destroy the validity of the persistence related properties of the matrix.
For RU matrices, zeros only the entry in \( R \).