Gudhi::persistence_matrix::Base_pairing< Master_matrix > Class Template Reference

Class managing the barcode for Boundary_matrix if the option was enabled. More...

Public Types
using	Bar = typename Master_matrix::Bar
using	barcode_type = typename Master_matrix::barcode_type
using	matrix_type = typename Master_matrix::column_container_type
using	index = typename Master_matrix::index
using	dimension_type = typename Master_matrix::dimension_type

Public Member Functions
	Base_pairing ()
	Default constructor.
	Base_pairing (const Base_pairing &matrixToCopy)
	Copy constructor. More...
	Base_pairing (Base_pairing &&other) noexcept
	Move constructor. More...
const barcode_type &	get_current_barcode ()
	Reduces the matrix stored in Boundary_matrix and computes the corresponding barcode. More...
Base_pairing &	operator= (Base_pairing other)
	Assign operator.

Friends
void	swap (Base_pairing &pairing1, Base_pairing &pairing2)
	Swap operator.

Detailed Description

template<class Master_matrix>
class Gudhi::persistence_matrix::Base_pairing< Master_matrix >

Class managing the barcode for Boundary_matrix if the option was enabled.

Template Parameters

Master_matrix

An instanciation of Matrix from which all types and options are deduced.

Member Typedef Documentation

Bar

template<class Master_matrix >

using Gudhi::persistence_matrix::Base_pairing< Master_matrix >::Bar = typename Master_matrix::Bar

Bar type.

barcode_type

template<class Master_matrix >

using Gudhi::persistence_matrix::Base_pairing< Master_matrix >::barcode_type = typename Master_matrix::barcode_type

Barcode type.

dimension_type

template<class Master_matrix >

using Gudhi::persistence_matrix::Base_pairing< Master_matrix >::dimension_type = typename Master_matrix::dimension_type

Dimension value type.

index

template<class Master_matrix >

using Gudhi::persistence_matrix::Base_pairing< Master_matrix >::index = typename Master_matrix::index

Container index type.

matrix_type

template<class Master_matrix >

using Gudhi::persistence_matrix::Base_pairing< Master_matrix >::matrix_type = typename Master_matrix::column_container_type

Column container type.

Constructor & Destructor Documentation

Base_pairing() [1/2]

template<class Master_matrix >

Gudhi::persistence_matrix::Base_pairing< Master_matrix >::Base_pairing ( const Base_pairing< Master_matrix > &  matrixToCopy )

inline

Copy constructor.

Parameters

matrixToCopy

Matrix to copy.

Base_pairing() [2/2]

template<class Master_matrix >

Gudhi::persistence_matrix::Base_pairing< Master_matrix >::Base_pairing ( Base_pairing< Master_matrix > &&  other )

inlinenoexcept

Move constructor.

Parameters

other

Matrix to move.

Member Function Documentation

get_current_barcode()

template<class Master_matrix >

const Base_pairing< Master_matrix >::barcode_type & Gudhi::persistence_matrix::Base_pairing< Master_matrix >::get_current_barcode

inline

Reduces the matrix stored in Boundary_matrix and computes the corresponding barcode.

Warning

The barcode will not be recomputed if the matrix is modified later after calling this method for the first time. So call it only once the matrix is finalized. This behaviour could be changed in the future, if the need is mentioned.

Returns

Const reference to the barcode.

---

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

• include/gudhi/Persistence_matrix/base_pairing.h