Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension > Class Template Reference

Class managing the maximal dimension of a cell represented in the inheriting matrix, when the option of cell removal is enabled. More...

#include <include/gudhi/Persistence_matrix/matrix_dimension_holders.h>

Public Member Functions
	Matrix_all_dimension_holder (Dimension maximalDimension=-1)
	Default constructor. If a dimension is specified, stores it as the maximal value. More...
	Matrix_all_dimension_holder (const Matrix_all_dimension_holder &toCopy)
	Copy constructor. More...
	Matrix_all_dimension_holder (Matrix_all_dimension_holder &&other) noexcept
	Move constructor. More...
Dimension	get_max_dimension () const
	Returns the maximal dimension of a cell represented in the matrix. More...
Matrix_all_dimension_holder &	operator= (Matrix_all_dimension_holder other)
	Assign operator.

Friends
void	swap (Matrix_all_dimension_holder &matrix1, Matrix_all_dimension_holder &matrix2)
	Swap operator.

Detailed Description

template<typename Dimension>
class Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension >

Class managing the maximal dimension of a cell represented in the inheriting matrix, when the option of cell removal is enabled.

Template Parameters

Dimension

Dimension value type. Has to be an integer type. If unsigned, the maximal value of the type should not be attained during a run.

Constructor & Destructor Documentation

Matrix_all_dimension_holder() [1/3]

template<typename Dimension >

Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension >::Matrix_all_dimension_holder ( Dimension  maximalDimension = -1 )

inline

Default constructor. If a dimension is specified, stores it as the maximal value.

Parameters

maximalDimension

Value of the maximal dimension. Has to be either positive or -1. Default value: -1.

Matrix_all_dimension_holder() [2/3]

template<typename Dimension >

Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension >::Matrix_all_dimension_holder ( const Matrix_all_dimension_holder< Dimension > &  toCopy )

inline

Copy constructor.

Parameters

toCopy

Matrix to copy.

Matrix_all_dimension_holder() [3/3]

template<typename Dimension >

Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension >::Matrix_all_dimension_holder ( Matrix_all_dimension_holder< Dimension > &&  other )

inlinenoexcept

Move constructor.

Parameters

other

Matrix to move.

Member Function Documentation

get_max_dimension()

template<typename Dimension >

Dimension Gudhi::persistence_matrix::Matrix_all_dimension_holder< Dimension >::get_max_dimension ( ) const

inline

Returns the maximal dimension of a cell represented in the matrix.

Returns

The maximal dimension.

---

The documentation for this class was generated from the following file:

• include/gudhi/Persistence_matrix/matrix_dimension_holders.h