Matrix cell class. Stores by default only the row index it belongs to, but can also store its column index when the row access is enabled, as well as its value when they are different from only 0 and 1. Zero-valued cells are never explicited in the matrix.
More...
#include <gudhi/Persistence_matrix/columns/cell_types.h>
|
using | Master = Master_matrix |
|
using | index = typename Master_matrix::index |
|
using | id_index = typename Master_matrix::id_index |
|
using | Field_element_type = typename Master_matrix::element_type |
|
template<class Master_matrix>
class Gudhi::persistence_matrix::Cell< Master_matrix >
Matrix cell class. Stores by default only the row index it belongs to, but can also store its column index when the row access is enabled, as well as its value when they are different from only 0 and 1. Zero-valued cells are never explicited in the matrix.
- Template Parameters
-
Master_matrix | An instanciation of Matrix from which all types and options are deduced. |
◆ Field_element_type
template<class Master_matrix >
◆ id_index
template<class Master_matrix >
◆ index
template<class Master_matrix >
◆ Master
template<class Master_matrix >
Access to options from outside.
◆ Cell() [1/4]
template<class Master_matrix >
Constructs a cell with given row index. Other possible attributes are set at default values.
- Parameters
-
◆ Cell() [2/4]
template<class Master_matrix >
Constructs a cell with given row and column index. Other possible attributes are set at default values.
- Parameters
-
columnIndex | Column index of the cell. |
rowIndex | Row index of the cell. |
◆ Cell() [3/4]
template<class Master_matrix >
Copy constructor.
- Parameters
-
◆ Cell() [4/4]
template<class Master_matrix >
Move constructor.
- Parameters
-
◆ get_row_index()
template<class Master_matrix >
Returns the row index stored in the cell.
- Returns
- Row index of the cell.
◆ operator id_index()
template<class Master_matrix >
Converts the cell into a row index.
- Returns
- The row index of the cell.
◆ operator std::pair< id_index, Field_element_type >()
template<class Master_matrix >
Converts the cell into a pair of row index and cell value.
- Returns
- A std::pair with first element the row index and second element the value.
◆ set_row_index()
template<class Master_matrix >
Sets the row index stored in the cell.
- Parameters
-
◆ operator<
template<class Master_matrix >
bool operator< |
( |
const Cell< Master_matrix > & |
c1, |
|
|
const Cell< Master_matrix > & |
c2 |
|
) |
| |
|
friend |
Strictly smaller than comparator.
- Parameters
-
c1 | First cell to compare. |
c2 | Second cell to compare. |
- Returns
- true If the row index of the first cell is strictly smaller than the row index of the second cell.
-
false Otherwise.
◆ operator==
template<class Master_matrix >
bool operator== |
( |
const Cell< Master_matrix > & |
c1, |
|
|
const Cell< Master_matrix > & |
c2 |
|
) |
| |
|
friend |
Equality comparator.
- Parameters
-
c1 | First cell to compare. |
c2 | Second cell to compare. |
- Returns
- true If the row index of the first cell is equal to the row index of the second cell.
-
false Otherwise.
The documentation for this class was generated from the following file: