#include <CGAL/HDVF/Sub_sparse_matrix.h>

Inherits from

CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >.

Definition

template<typename CoefficientRing, int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>
class CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >

The class Sub_sparse_matrix_core is a technical class implementing the concept SparseMatrix together with a system of masks to partially screen matrices (and restrict computations to a subset of indices along their major direction).

This class is used to compute reduced homology (and thus to compute persistent homology and Alexander duality).

Sub_sparse_matrix_core inherits Sparse_matrix_core structure and basically adds two bitboards:

one describing indices of cells belonging to the subset of indices considered (let us denote it by \(A\))
the second providing indices of non-empty chains in \(A\)

The class does not modify linear algebra operators, but focuses on adapted iterators, output operators and methods to adjust the "mask".

Is model of: SparseMatrix

Template Parameters

CoefficientRing	a model of the `IntegralDomainWithoutDivision` concept, providing the ring used to compute homology.
StorageFormat	an integer constant encoding the storage format of matrices (`OSM::COLUMN` or `OSM::ROW`).
SparseChainType	a model of `SparseChain` used to store chains of the sparse matrix (default: `OSM::Sparse_chain`).

Public Member Functions
	Sub_sparse_matrix_core (size_t rowCount=0, size_t columnCount=0)
	Constructor with given rows/columns sizes and mask set to `full`.

	Sub_sparse_matrix_core (size_t rowCount, size_t columnCount, const Bitboard &subChain)
	Constructor with given rows/columns sizes and a mask.

	Sub_sparse_matrix_core (const Sub_sparse_matrix_core &otherToCopy)
	Copy constructor.

	Sub_sparse_matrix_core (const Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType > &otherToCopy)
	Copy constructor.

Bitboard::iterator	begin () const noexcept
	Iterator to the beginning of the indices of non empty chains inside the mask.

Bitboard::iterator	end () const noexcept
	Iterator past-the-end of the indices of non empty chains inside the mask.

void	set_sub (const Bitboard &new_subChains)
	Changes the indices subset mask.

void	set_bit_on (size_t index)
	Adds an index to the mask.

void	set_bit_off (size_t index)
	Removes an index from the mask.

void	complement ()
	Changes the mask to its complement.

Sub_sparse_matrix_core &	operator= (const Sub_sparse_matrix_core &otherToCopy)
	Assignment.

bool	is_null () const
	Tests if a `Sub_sparse_matrix_core` is null.

bool	is_null (const Bitboard &b) const
	Tests if a `Sub_sparse_matrix_core` with chains restricted to a `Bitboard` is null.

Public Member Functions inherited from CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >
	Sparse_matrix_core ()
	Default constructor.

	Sparse_matrix_core (const size_t rowCount, const size_t columnCount)
	Constructor with given rows/columns sizes.

	Sparse_matrix_core (const std::pair< size_t, size_t > dimensions)
	Constructor with given pair of rows/columns sizes.

	Sparse_matrix_core (const Sparse_matrix_core &otherToCopy)=default

template<int CTF>
	Sparse_matrix_core (const Sparse_matrix_core< CoefficientRing, CTF, SparseChainType > &otherToCopy)
	Copy constructor.

void	eye (size_t nrows, size_t ncols)
	Sets an identity matrix.

void	eye (std::pair< size_t, size_t > dimensions)
	Sets an identity matrix.

Sparse_matrix_core &	operator= (const Sparse_matrix_core &otherToCopy)=default
	Assignment.

void	nullify ()
	Cleans a SparseMatrix (set all coefficients to zero).

bool	is_null ()
	Tests if a `Sparse_matrix_core` is null.

bool	is_empty ()
	Tests if a `Sparse_matrix_core` is empty.

int	storage_format () const
	Returns the storage format of the matrix.

template<int _CTF>
Sparse_matrix_core	operator+ (const Sparse_matrix_core< CoefficientRing, _CTF > &other)
	Adds two matrices into a new matrix.

template<int _CTF>
Sparse_matrix_core	operator- (const Sparse_matrix_core< CoefficientRing, _CTF > &other)
	Subtracts two matrices into a new matrix.

Sparse_matrix_core	operator* (const CoefficientRing &lambda)
	Applies factor on each coefficients into a new matrix.

Sparse_matrix_core &	operator*= (const CoefficientRing &lambda)
	Applies factor on each coefficients and assign.

Sparse_matrix_core	operator- ()
	Computes the negative of a matrix (unary operator).

Matrix_chain	operator[] (size_t index) const
	Gets the value of a chain from a const matrix.

Matrix_chain	chain (size_t index) const
	Gets the value of a chain from a const matrix.

Sparse_matrix_core	operator/ (const std::vector< size_t > &_indices)
	Removes a set of chains from a copy of the matrix.

Sparse_matrix_core	operator/ (size_t index)
	Removes the chain at a given `index` from a copy of the matrix.

Sparse_matrix_core &	operator/= (const std::vector< size_t > &indices)
	Removes a set of chains from a matrix.

Sparse_matrix_core &	operator/= (const size_t index)
	Removes the chain at a given `index` from a matrix.

Bitboard::iterator	begin () const noexcept
	Iterator to the index of the first non null chain.

Bitboard::iterator	end () const noexcept
	Iterator past-the-end of chain indices.

Bitboard::reverse_iterator	reverse_begin () noexcept
	Reverse iterator to the index of the last non null chain.

Bitboard::reverse_iterator	reverse_begin (size_t index) noexcept

Bitboard::reverse_iterator	reverse_end () noexcept
	Reverse iterator past-the-end of chain indices.

Sparse_matrix_core< Coefficient_ring,(COLUMN\|ROW)&(~StorageFormat), SparseChainType >	transpose () const
	Transposes a matrix.

std::pair< size_t, size_t >	dimensions () const
	Gets the matrix sizes.

Protected Attributes
Bitboard	_subChains

Bitboard	_subChainsStates

Protected Attributes inherited from CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >
std::vector< Sparse_chain_type< CoefficientRing, StorageFormat > >	_chains

Bitboard	_chainsStates

std::pair< size_t, size_t >	_size

Friends
std::ostream &	operator<< (std::ostream &stream, const Sub_sparse_matrix_core &matrix)
	Displays a `Sub_sparse_matrix_core` in the output stream.

Additional Inherited Members
Public Types inherited from CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >
typedef CoefficientRing	Coefficient_ring
	Type of coefficient ring.

template<typename _CT , int _SF>
using	Sparse_chain_type = SparseChainType< _CT, _SF >
	Type of sparse chains used in the matrix.

typedef Sparse_chain_type< CoefficientRing, StorageFormat >	Matrix_chain
	Type of chains associated to the matrix.

Protected Member Functions inherited from CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >
Matrix_chain &	operator[] (const size_t _index)

void	set_coefficient (const size_t i, const size_t j, const Coefficient_ring d)

Coefficient_ring	get_coefficient (const size_t i, const size_t j) const

Sparse_matrix_core &	remove_column (size_t index)

Sparse_matrix_core &	remove_row (size_t index)

Sparse_matrix_core &	swap_rows (size_t i, size_t j)

Sparse_matrix_core &	swap_columns (size_t i, size_t j)

Sparse_matrix_core &	remove_coefficient (size_t i, size_t j)

Related Functions inherited from CGAL::OSM::Sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >
template<typename _CT , template< typename, int > typename SCT>
bool	operator== (const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &other)
	Comparison of two COLUMN matrices.

template<typename _CT , template< typename, int > typename SCT>
bool	operator== (const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, OSM::ROW, SCT > &other)
	Comparison of a COLUMN and a ROW matrix.

template<typename _CT , template< typename, int > typename SCT>
bool	operator== (const Sparse_matrix_core< _CT, OSM::ROW, SCT > &matrix, const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &other)
	Comparison of a ROW and a COLUMN matrix.

template<typename _CT , template< typename, int > typename SCT>
bool	operator== (const Sparse_matrix_core< _CT, OSM::ROW, SCT > &matrix, const Sparse_matrix_core< _CT, OSM::ROW, SCT > &other)
	Comparison of two ROW matrices.

std::ostream &	operator<< (std::ostream &stream, const Sparse_matrix_core &matrix)
	Writes a sparse matrix in the output stream.

template<typename _CT , template< typename, int > typename SCT>
std::ostream &	write_matrix (const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &M, std::ostream &out)
	Writes a sparse COLUMN matrix to a stream.

template<typename _CT , template< typename, int > typename SCT>
std::ostream &	write_matrix (const Sparse_matrix_core< _CT, OSM::ROW, SCT > &M, std::ostream &out)
	Writes a sparse ROW matrix to a stream.

template<typename _CT , template< typename, int > typename SCT>
void	write_matrix (const Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &M, std::string filename)
	Writes a sparse COLUMN matrix to a file.

template<typename _CT , template< typename, int > typename SCT>
void	write_matrix (const Sparse_matrix_core< _CT, OSM::ROW, SCT > &M, std::string filename)
	Writes a sparse ROW matrix to a file.

template<typename _CT , template< typename, int > typename SCT>
std::istream &	read_matrix (Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &M, std::istream &in)
	Reads a sparse COLUMN matrix from a stream.

template<typename _CT , template< typename, int > typename SCT>
std::istream &	read_matrix (Sparse_matrix_core< _CT, OSM::ROW, SCT > &M, std::istream &in)
	Reads a sparse ROW matrix from a stream.

template<typename _CT , template< typename, int > typename SCT>
void	read_matrix (Sparse_matrix_core< _CT, OSM::COLUMN, SCT > &M, std::string filename)
	Reads a sparse COLUMN matrix from a file.

template<typename _CT , template< typename, int > typename SCT>
void	read_matrix (Sparse_matrix_core< _CT, OSM::ROW, SCT > &M, std::string filename)
	Reads a sparse ROW matrix from a file.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core	operator* (const _CT &lambda, const Sparse_matrix_core< _CT, _CTF, SCT > &matrix)
	Applies factor on each coefficients into a new matrix.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT >	operator* (const Sparse_matrix_core< _CT, COLUMN, SCT > &first, const Sparse_matrix_core< _CT, COLUMN, SCT > &second)
	Matrix multiplication: COLUMN x COLUMN -> COLUMN.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT >	operator* (const Sparse_matrix_core< _CT, ROW, SCT > &first, const Sparse_matrix_core< _CT, COLUMN, SCT > &second)
	Matrix multiplication: ROW x COLUMN -> COLUMN.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT >	operator* (const Sparse_matrix_core< _CT, COLUMN, SCT > &first, const Sparse_matrix_core< _CT, ROW, SCT > &second)
	Matrix multiplication: COLUMN x ROW -> COLUMN.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT >	operator* (const Sparse_matrix_core< _CT, ROW, SCT > &first, const Sparse_matrix_core< _CT, ROW, SCT > &second)
	Matrix multiplication: ROW x ROW -> COLUMN.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, COLUMN >	operator* (const Sparse_matrix_core< _CT, COLUMN, SCT > &_matrix, const SCT< _CT, COLUMN > &_column)
	Matrix/column chain multiplication: COLUMN matrix x COLUMN chain -> COLUMN chain.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, COLUMN >	operator* (const Sparse_matrix_core< _CT, ROW, SCT > &_matrix, const SCT< _CT, COLUMN > &_column)
	Matrix/column chain multiplication: ROW matrix x COLUMN chain -> COLUMN chain.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, ROW >	operator* (const SCT< _CT, ROW > &_row, const Sparse_matrix_core< _CT, ROW, SCT > &_matrix)
	Row chain/matrix multiplication: ROW chain x COLUMN matrix -> ROW chain.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, ROW >	operator* (const SCT< _CT, ROW > &_row, const Sparse_matrix_core< _CT, COLUMN, SCT > &_matrix)
	Row chain/matrix multiplication: ROW chain x ROW matrix -> ROW chain.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT >	operator% (const Sparse_matrix_core< _CT, COLUMN, SCT > &_first, const Sparse_matrix_core< _CT, COLUMN, SCT > &_second)
	matrix multiplication: COLUMN x COLUMN -> ROW

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT >	operator% (const Sparse_matrix_core< _CT, ROW, SCT > &_first, const Sparse_matrix_core< _CT, COLUMN, SCT > &_second)
	matrix multiplication: ROW x COLUMN -> ROW

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT >	operator% (const Sparse_matrix_core< _CT, COLUMN, SCT > &_first, const Sparse_matrix_core< _CT, ROW, SCT > &_second)
	matrix multiplication: COLUMN x ROW -> ROW

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT >	operator% (const Sparse_matrix_core< _CT, ROW, SCT > &_first, const Sparse_matrix_core< _CT, ROW, SCT > &_second)
	matrix multiplication: ROW x ROW -> ROW

Sparse_matrix_core &	operator+= (const Sparse_matrix_core &other)
	Matrices sum and assign: COLUMN += COLUMN or ROW += ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT > &	operator+= (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, ROW, SCT > &other)
	Matrices sum and assign: COLUMN += ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT > &	operator+= (Sparse_matrix_core< _CT, ROW, SCT > &matrix, const Sparse_matrix_core< _CT, COLUMN, SCT > &other)
	Matrices sum and assign: ROW += COLUMN.

Sparse_matrix_core &	operator-= (const Sparse_matrix_core &other)
	Matrices subtraction and assign: COLUMN -= COLUMN or ROW -= ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT > &	operator-= (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, ROW, SCT > &other)
	Matrices subtraction and assign: COLUMN -= ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT > &	operator-= (Sparse_matrix_core< _CT, ROW, SCT > &matrix, const Sparse_matrix_core< _CT, COLUMN, SCT > &other)
	Matrices subtraction and assign: ROW -= COLUMN.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT > &	*operator=** (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, COLUMN, SCT > &other)
	Matrix multiplication and assign: COLUMN *= COLUMN.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT > &	*operator=** (Sparse_matrix_core< _CT, ROW, SCT > &matrix, const Sparse_matrix_core< _CT, ROW, SCT > &other)
	Matrix multiplication and assign: ROW *= ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, COLUMN, SCT > &	*operator=** (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, const Sparse_matrix_core< _CT, ROW, SCT > &other)
	Matrix multiplication and assign: COLUMN *= ROW.

template<typename _CT , template< typename, int > typename SCT>
Sparse_matrix_core< _CT, ROW, SCT > &	*operator=** (Sparse_matrix_core< _CT, ROW, SCT > &matrix, const Sparse_matrix_core< _CT, COLUMN, SCT > &other)
	Matrix multiplication and assign: ROW *= COLUMN.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
void	set_coefficient (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t i, size_t j, const _CT d)
	Sets a given coefficient in `matrix`.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
_CT	get_coefficient (const Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t i, size_t j)
	Gets a given coefficient.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, COLUMN >	get_column (const Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, size_t index)
	Gets a column from a COLUMN matrix.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, COLUMN >	get_column (const Sparse_matrix_core< _CT, ROW, SCT > &matrix, size_t index)
	Gets a column from a ROW matrix.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, ROW >	get_row (const Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, size_t index)
	Gets a row from a COLUMN matrix.

template<typename _CT , template< typename, int > typename SCT>
SCT< _CT, ROW >	get_row (const Sparse_matrix_core< _CT, ROW, SCT > &matrix, size_t index)
	Gets a row from a ROW matrix.

template<typename _CT , template< typename, int > typename SCT>
const SCT< _CT, COLUMN > &	cget_column (const Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, size_t index)
	Gets a const reference over a column from a column matrix.

template<typename _CT , template< typename, int > typename SCT>
const SCT< _CT, ROW > &	cget_row (const Sparse_matrix_core< _CT, ROW, SCT > &matrix, const size_t index)
	Gets a constant reference over a row from a row matrix.

template<typename _CT , template< typename, int > typename SCT>
void	set_column (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, size_t index, const SCT< _CT, COLUMN > &column)
	Sets a column in a COLUMN matrix.

template<typename _CT , template< typename, int > typename SCT>
void	set_column (Sparse_matrix_core< _CT, ROW, SCT > &matrix, size_t index, const SCT< _CT, COLUMN > &column)
	Sets a column in a ROW matrix.

template<typename _CT , template< typename, int > typename SCT>
void	set_row (Sparse_matrix_core< _CT, COLUMN, SCT > &matrix, size_t index, const SCT< _CT, ROW > &row)
	Sets a row in a COLUMN matrix.

template<typename _CT , template< typename, int > typename SCT>
void	set_row (Sparse_matrix_core< _CT, ROW, SCT > &matrix, size_t index, const SCT< _CT, ROW > &row)
	Sets a row in a ROW matrix.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core< _CT, _CTF, SCT > &	remove_column (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t index)
	Removes a column from the matrix.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core< _CT, _CTF, SCT > &	remove_row (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t index)
	Removes a row from the matrix.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core< _CT, _CTF, SCT > &	swap_rows (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t i, size_t j)
	Swaps rows in a matrix.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core< _CT, _CTF, SCT > &	swap_columns (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t i, size_t j)
	Swaps columns in a matrix.

template<typename _CT , int _CTF, template< typename, int > typename SCT>
Sparse_matrix_core< _CT, _CTF, SCT > &	remove_coefficient (Sparse_matrix_core< _CT, _CTF, SCT > &matrix, size_t i, size_t j)
	Removes a coefficient from the matrix.

Constructor & Destructor Documentation

◆ Sub_sparse_matrix_core() [1/2]

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::Sub_sparse_matrix_core	(	size_t	rowCount = `0`,
		size_t	columnCount = `0`
	)

Constructor with given rows/columns sizes and mask set to full.

Constructor with sizes, initializes an empty Sub_sparse_matrix_core of a given size along rows/columns. The constructor sets the mask to full.

Parameters

rowCount	The number of rows to preallocate (default 0).
columnCount	The number of columns to preallocate (default 0).

◆ Sub_sparse_matrix_core() [2/2]

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::Sub_sparse_matrix_core	(	size_t	rowCount,
		size_t	columnCount,
		const Bitboard &	subChain
	)

Constructor with given rows/columns sizes and a mask.

Create a new empty Sub_sparse_matrix_core of given size along rows/columns and a given mask.

Parameters

rowCount	The number of rows to preallocate.
columnCount	The number of columns to preallocate.
subChain	Bitboard describing the subset of indices considered as a mask.

Member Function Documentation

◆ is_null() [1/2]

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

bool CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::is_null ( ) const

Tests if a Sub_sparse_matrix_core is null.

The function return true is the Sub_sparse_matrix_core is null (that is, all the chains in the mask are empty) and false otherwise.

◆ is_null() [2/2]

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

bool CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::is_null ( const Bitboard & b ) const

Tests if a Sub_sparse_matrix_core with chains restricted to a Bitboard is null.

The function return true is the restricted Sub_sparse_matrix_core is null (that is, all the chains in the mask, restricted to the Bitboard b are null) and false otherwise.

◆ set_bit_off()

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

void CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::set_bit_off ( size_t index )

Removes an index from the mask.

Set the bit encoding a given index to 0 (ie. remove the index from the mask).

Parameters

index Index to turn off in the mask.

◆ set_bit_on()

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

void CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::set_bit_on ( size_t index )

Adds an index to the mask.

Set the bit encoding a given index to 1 (ie. add the index in the mask).

Parameters

index Index to turn on in the mask.

◆ set_sub()

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

void CGAL::OSM::Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType >::set_sub ( const Bitboard & new_subChains )

Changes the indices subset mask.

Set a new mask encoding a new subset of indices along the major dimension.

Friends And Related Function Documentation

◆ operator<<

template<typename CoefficientRing , int StorageFormat, template< typename, int > typename SparseChainType = OSM::Sparse_chain>

std::ostream & operator<<	(	std::ostream &	stream,
		const Sub_sparse_matrix_core< CoefficientRing, StorageFormat, SparseChainType > &	matrix
	)

friend

Displays a Sub_sparse_matrix_core in the output stream.

Displays the sparse matrix as well as its mask.

Parameters

stream	The output stream.
matrix	The matrix to display.

Returns: A reference to the modified stream.

Inherits from

Definition

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ Sub_sparse_matrix_core() [1/2]

◆ Sub_sparse_matrix_core() [2/2]

Member Function Documentation

◆ is_null() [1/2]

◆ is_null() [2/2]

◆ set_bit_off()

◆ set_bit_on()

◆ set_sub()

Friends And Related Function Documentation

◆ operator<<