Matrix entry 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 entries are never made explicit in the matrix.
More...
#include <gudhi/Persistence_matrix/columns/entry_types.h>
|
using | Master = Master_matrix |
|
using | Index = typename Master_matrix::Index |
|
using | ID_index = typename Master_matrix::ID_index |
|
using | Field_element = typename Master_matrix::Element |
|
template<class Master_matrix>
class Gudhi::persistence_matrix::Entry< Master_matrix >
Matrix entry 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 entries are never made explicit in the matrix.
- Template Parameters
-
Master_matrix | An instantiation of Matrix from which all types and options are deduced. |
◆ Field_element
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.
◆ Entry() [1/4]
template<class Master_matrix >
Constructs an entry with given row index. Other possible attributes are set at default values.
- Parameters
-
◆ Entry() [2/4]
template<class Master_matrix >
Constructs an entry with given row and column index. Other possible attributes are set at default values.
- Parameters
-
columnIndex | Column index of the entry. |
rowIndex | Row index of the entry. |
◆ Entry() [3/4]
template<class Master_matrix >
Copy constructor.
- Parameters
-
◆ Entry() [4/4]
template<class Master_matrix >
Move constructor.
- Parameters
-
◆ get_row_index()
template<class Master_matrix >
Returns the row index stored in the entry.
- Returns
- Row index of the entry.
◆ operator ID_index()
template<class Master_matrix >
Converts the entry into a row index.
- Returns
- The row index of the entry.
◆ operator std::pair< ID_index, Field_element >()
template<class Master_matrix >
Converts the entry into a pair of row index and entry 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 entry.
- Parameters
-
◆ operator<
template<class Master_matrix >
bool operator< |
( |
const Entry< Master_matrix > & |
c1, |
|
|
const Entry< Master_matrix > & |
c2 |
|
) |
| |
|
friend |
Strictly smaller than comparator.
- Parameters
-
c1 | First entry to compare. |
c2 | Second entry to compare. |
- Returns
- true If the row index of the first entry is strictly smaller than the row index of the second entry.
-
false Otherwise.
◆ operator==
template<class Master_matrix >
bool operator== |
( |
const Entry< Master_matrix > & |
c1, |
|
|
const Entry< Master_matrix > & |
c2 |
|
) |
| |
|
friend |
Equality comparator.
- Parameters
-
c1 | First entry to compare. |
c2 | Second entry to compare. |
- Returns
- true If the row index of the first entry is equal to the row index of the second entry.
-
false Otherwise.
The documentation for this class was generated from the following file: