Detailed Description

Declares a matrix of booleans (non serializable).

See also: CMatrixDouble, CMatrixFloat, CMatrixB

Definition at line 696 of file CMatrixTemplate.h.

#include <mrpt/math/CMatrixTemplate.h>

Inheritance diagram for mrpt::math::CMatrixBool:

Public Types
using	value_type = bool
	The type of the matrix elements. More...

using	reference = bool &

using	const_reference = const bool &

using	size_type = std::size_t

using	difference_type = std::ptrdiff_t

Public Member Functions
	CMatrixBool (size_t row=1, size_t col=1)
	Constructor. More...

	CMatrixBool (const CMatrixTemplate< bool > &m)
	Copy constructor. More...

CMatrixBool &	operator= (const CMatrixTemplate< bool > &m)
	Assignment operator for float matrixes. More...

void	ASSERT_ENOUGHROOM (size_t r, size_t c) const
	Checks whether the rows [r-N,r+N] and the columns [c-N,c+N] are present in the matrix. More...

void	fillAll (const bool &val)

void	swap (CMatrixTemplate< bool > &o)
	Swap with another matrix very efficiently (just swaps a pointer and two integer values). More...

size_t	rows () const
	Number of rows in the matrix. More...

size_t	cols () const
	Number of columns in the matrix. More...

CMatrixTemplateSize	size () const
	Get a 2-vector with [NROWS NCOLS] (as in MATLAB command size(x)) More...

void	setSize (size_t row, size_t col, bool zeroNewElements=false)
	Changes the size of matrix, maintaining the previous contents. More...

void	resize (const CMatrixTemplateSize &siz, bool zeroNewElements=false)
	This method just checks has no effects in this class, but raises an exception if the expected size does not match. More...

bool &	operator() (size_t row, size_t col)
	Subscript operator to get/set individual elements. More...

const bool &	operator() (size_t row, size_t col) const
	Subscript operator to get individual elements. More...

bool &	operator() (size_t ith)
	Subscript operator to get/set an individual element from a row or column matrix. More...

bool	operator() (size_t ith) const
	Subscript operator to get/set an individual element from a row or column matrix. More...

CMatrixTemplate< bool >	operator() (const size_t row1, const size_t row2, const size_t col1, const size_t col2) const
	Subscript operator to get a submatrix. More...

void	set_unsafe (size_t row, size_t col, const bool &v)
	Fast but unsafe method to write a value in the matrix. More...

const bool &	get_unsafe (size_t row, size_t col) const
	Fast but unsafe method to read a value from the matrix. More...

bool &	get_unsafe (size_t row, size_t col)
	Fast but unsafe method to get a reference from the matrix. More...

bool *	get_unsafe_row (size_t row)
	Fast but unsafe method to obtain a pointer to a given row of the matrix (Use only in time critical applications) More...

const bool *	get_unsafe_row (size_t row) const
	Fast but unsafe method to obtain a pointer to a given row of the matrix (Use only in critical applications) More...

void	extractSubmatrix (const size_t row1, const size_t row2, const size_t col1, const size_t col2, CMatrixTemplate< bool > &out) const
	Get a submatrix, given its bounds. More...

void	extractSubmatrix (const size_t row1, const size_t row2, const size_t col1, const size_t col2, EIGEN_MATRIX &out) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	extractRows (size_t firstRow, size_t lastRow, CMatrixTemplate< bool > &out) const
	Gets a series of contiguous rows. More...

void	extractColumns (size_t firstCol, size_t lastCol, CMatrixTemplate< bool > &out) const
	Gets a series of contiguous columns. More...

void	extractCol (size_t nCol, std::vector< bool > &out, int startingRow=0) const
	Returns a given column to a vector (without modifying the matrix) More...

void	extractCol (size_t nCol, CMatrixTemplate< bool > &out, int startingRow=0) const
	Gets a given column to a vector (without modifying the matrix) More...

void	appendRow (const std::vector< bool > &in)
	Appends a new row to the MxN matrix from a 1xN vector. More...

void	appendCol (const std::vector< bool > &in)
	Appends a new column to the matrix from a vector. More...

void	insertCol (size_t nCol, const std::vector< bool > &in)
	Inserts a column from a vector, replacing the current contents of that column. More...

void	getAsVector (std::vector< bool > &out) const
	Returns a vector containing the matrix's values. More...

Protected Member Functions
void	realloc (size_t row, size_t col, bool newElementsToZero=false)
	Internal use only: It reallocs the memory for the 2D matrix, maintaining the previous contents if posible. More...

Protected Attributes
bool **	m_Val

size_t	m_Rows

size_t	m_Cols

Member Typedef Documentation

◆ const_reference

using mrpt::math::CMatrixTemplate< bool >::const_reference = const bool &

inherited

Definition at line 79 of file CMatrixTemplate.h.

◆ difference_type

using mrpt::math::CMatrixTemplate< bool >::difference_type = std::ptrdiff_t

inherited

Definition at line 81 of file CMatrixTemplate.h.

◆ reference

using mrpt::math::CMatrixTemplate< bool >::reference = bool &

inherited

Definition at line 78 of file CMatrixTemplate.h.

◆ size_type

using mrpt::math::CMatrixTemplate< bool >::size_type = std::size_t

inherited

Definition at line 80 of file CMatrixTemplate.h.

◆ value_type

using mrpt::math::CMatrixTemplate< bool >::value_type = bool

inherited

The type of the matrix elements.

Definition at line 77 of file CMatrixTemplate.h.

Constructor & Destructor Documentation

◆ CMatrixBool() [1/2]

CMatrixBool::CMatrixBool	(	size_t	row = `1`,
		size_t	col = `1`
	)

Constructor.

Definition at line 64 of file CMatrixB.cpp.

◆ CMatrixBool() [2/2]

CMatrixBool::CMatrixBool ( const CMatrixTemplate< bool > & m )

Copy constructor.

Definition at line 68 of file CMatrixB.cpp.

Member Function Documentation

◆ appendCol()

void mrpt::math::CMatrixTemplate< bool >::appendCol ( const std::vector< T > & in )

inlineinherited

Appends a new column to the matrix from a vector.

The length of the vector must match the number of rows of the matrix, unless it is (0,0).

Exceptions

std::exception On size mismatch.

See also: extractCol; appendRow

Definition at line 649 of file CMatrixTemplate.h.

◆ appendRow()

void mrpt::math::CMatrixTemplate< bool >::appendRow ( const std::vector< T > & in )

inlineinherited

Appends a new row to the MxN matrix from a 1xN vector.

The lenght of the vector must match the width of the matrix, unless it's empty: in that case the matrix is resized to 1xN.

CMatrixDouble  M(0,0);
CVectorDouble  v(7),w(7);
// ...
M.appendRow(v);
M.appendRow(w);

Exceptions

std::exception On incorrect vector length.

See also: extractRow; appendCol

Definition at line 620 of file CMatrixTemplate.h.

◆ ASSERT_ENOUGHROOM()

void mrpt::math::CMatrixTemplate< bool >::ASSERT_ENOUGHROOM	(	size_t	r,
		size_t	c
	)		const

inlineinherited

Checks whether the rows [r-N,r+N] and the columns [c-N,c+N] are present in the matrix.

Definition at line 150 of file CMatrixTemplate.h.

◆ cols()

size_t mrpt::math::CMatrixTemplate< bool >::cols ( ) const

inlineinherited

Number of columns in the matrix.

See also: rows(), getColCount, nr, nc

Definition at line 302 of file CMatrixTemplate.h.

◆ extractCol() [1/2]

void mrpt::math::CMatrixTemplate< bool >::extractCol	(	size_t	nCol,
		CMatrixTemplate< T > &	out,
		int	startingRow = `0`
	)		const

inlineinherited

Gets a given column to a vector (without modifying the matrix)

Exceptions

std::exception On index out of bounds

Definition at line 591 of file CMatrixTemplate.h.

◆ extractCol() [2/2]

void mrpt::math::CMatrixTemplate< bool >::extractCol	(	size_t	nCol,
		std::vector< T > &	out,
		int	startingRow = `0`
	)		const

inlineinherited

Returns a given column to a vector (without modifying the matrix)

Exceptions

std::exception On index out of bounds

Definition at line 574 of file CMatrixTemplate.h.

◆ extractColumns()

void mrpt::math::CMatrixTemplate< bool >::extractColumns	(	size_t	firstCol,
		size_t	lastCol,
		CMatrixTemplate< T > &	out
	)		const

inlineinherited

Gets a series of contiguous columns.

Exceptions

std::logic_error On index out of bounds

See also: extractColumn; extractRows

Definition at line 564 of file CMatrixTemplate.h.

◆ extractRows()

void mrpt::math::CMatrixTemplate< bool >::extractRows	(	size_t	firstRow,
		size_t	lastRow,
		CMatrixTemplate< T > &	out
	)		const

inlineinherited

Gets a series of contiguous rows.

Exceptions

std::logic_error On index out of bounds

See also: extractRow; extractColumns

Definition at line 552 of file CMatrixTemplate.h.

◆ extractSubmatrix() [1/2]

void mrpt::math::CMatrixTemplate< bool >::extractSubmatrix	(	const size_t	row1,
		const size_t	row2,
		const size_t	col1,
		const size_t	col2,
		CMatrixTemplate< T > &	out
	)		const

inlineinherited

Get a submatrix, given its bounds.

See also: extractSubmatrixSymmetricalBlocks

Definition at line 508 of file CMatrixTemplate.h.

◆ extractSubmatrix() [2/2]

void mrpt::math::CMatrixTemplate< bool >::extractSubmatrix	(	const size_t	row1,
		const size_t	row2,
		const size_t	col1,
		const size_t	col2,
		EIGEN_MATRIX &	out
	)		const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 528 of file CMatrixTemplate.h.

◆ fillAll()

void mrpt::math::CMatrixTemplate< bool >::fillAll ( const T & val )

inlineinherited

Fill all the elements with a given value (Note: named "fillAll" since "fill" will be used by child classes)

Definition at line 158 of file CMatrixTemplate.h.

◆ get_unsafe() [1/2]

bool & mrpt::math::CMatrixTemplate< bool >::get_unsafe	(	size_t	row,
		size_t	col
	)

inlineinherited

Fast but unsafe method to get a reference from the matrix.

Definition at line 458 of file CMatrixTemplate.h.

◆ get_unsafe() [2/2]

const bool & mrpt::math::CMatrixTemplate< bool >::get_unsafe	(	size_t	row,
		size_t	col
	)		const

inlineinherited

Fast but unsafe method to read a value from the matrix.

Definition at line 441 of file CMatrixTemplate.h.

◆ get_unsafe_row() [1/2]

bool * mrpt::math::CMatrixTemplate< bool >::get_unsafe_row ( size_t row )

inlineinherited

Fast but unsafe method to obtain a pointer to a given row of the matrix (Use only in time critical applications)

Definition at line 476 of file CMatrixTemplate.h.

◆ get_unsafe_row() [2/2]

const bool * mrpt::math::CMatrixTemplate< bool >::get_unsafe_row ( size_t row ) const

inlineinherited

Fast but unsafe method to obtain a pointer to a given row of the matrix (Use only in critical applications)

Definition at line 493 of file CMatrixTemplate.h.

◆ getAsVector()

void mrpt::math::CMatrixTemplate< bool >::getAsVector ( std::vector< T > & out ) const

inlineinherited

Returns a vector containing the matrix's values.

Definition at line 682 of file CMatrixTemplate.h.

◆ insertCol()

void mrpt::math::CMatrixTemplate< bool >::insertCol	(	size_t	nCol,
		const std::vector< T > &	in
	)

inlineinherited

Inserts a column from a vector, replacing the current contents of that column.

Exceptions

std::exception On index out of bounds

See also: extractCol

Definition at line 669 of file CMatrixTemplate.h.

◆ operator()() [1/5]

CMatrixTemplate<bool > mrpt::math::CMatrixTemplate< bool >::operator()	(	const size_t	row1,
		const size_t	row2,
		const size_t	col1,
		const size_t	col2
	)		const

inlineinherited

Subscript operator to get a submatrix.

Definition at line 496 of file CMatrixTemplate.h.

◆ operator()() [2/5]

bool & mrpt::math::CMatrixTemplate< bool >::operator() ( size_t ith )

inlineinherited

Subscript operator to get/set an individual element from a row or column matrix.

Exceptions

std::exception If the object is not a column or row matrix.

Definition at line 364 of file CMatrixTemplate.h.

◆ operator()() [3/5]

bool mrpt::math::CMatrixTemplate< bool >::operator() ( size_t ith ) const

inlineinherited

Subscript operator to get/set an individual element from a row or column matrix.

Exceptions

std::exception If the object is not a column or row matrix.

Definition at line 395 of file CMatrixTemplate.h.

◆ operator()() [4/5]

bool & mrpt::math::CMatrixTemplate< bool >::operator()	(	size_t	row,
		size_t	col
	)

inlineinherited

Subscript operator to get/set individual elements.

Definition at line 328 of file CMatrixTemplate.h.

◆ operator()() [5/5]

const bool & mrpt::math::CMatrixTemplate< bool >::operator()	(	size_t	row,
		size_t	col
	)		const

inlineinherited

Subscript operator to get individual elements.

Definition at line 345 of file CMatrixTemplate.h.

◆ operator=()

CMatrixBool & CMatrixBool::operator= ( const CMatrixTemplate< bool > & m )

Assignment operator for float matrixes.

Definition at line 72 of file CMatrixB.cpp.

References mrpt::math::CMatrixTemplate< T >::operator=().

Referenced by mrpt::math::CMatrixB::operator=().

◆ realloc()

void mrpt::math::CMatrixTemplate< bool >::realloc	(	size_t	row,
		size_t	col,
		bool	newElementsToZero = `false`
	)

inlineprotectedinherited

Internal use only: It reallocs the memory for the 2D matrix, maintaining the previous contents if posible.

Definition at line 90 of file CMatrixTemplate.h.

◆ resize()

void mrpt::math::CMatrixTemplate< bool >::resize	(	const CMatrixTemplateSize &	siz,
		bool	zeroNewElements = `false`
	)

inlineinherited

This method just checks has no effects in this class, but raises an exception if the expected size does not match.

Definition at line 320 of file CMatrixTemplate.h.

◆ rows()

size_t mrpt::math::CMatrixTemplate< bool >::rows ( ) const

inlineinherited

Number of rows in the matrix.

See also: rows(), getColCount, nr, nc

Definition at line 298 of file CMatrixTemplate.h.

◆ set_unsafe()

void mrpt::math::CMatrixTemplate< bool >::set_unsafe	(	size_t	row,
		size_t	col,
		const T &	v
	)

inlineinherited

Fast but unsafe method to write a value in the matrix.

Definition at line 424 of file CMatrixTemplate.h.

◆ setSize()

void mrpt::math::CMatrixTemplate< bool >::setSize	(	size_t	row,
		size_t	col,
		bool	zeroNewElements = `false`
	)

inlineinherited

Changes the size of matrix, maintaining the previous contents.

Definition at line 313 of file CMatrixTemplate.h.

◆ size()

CMatrixTemplateSize mrpt::math::CMatrixTemplate< bool >::size ( ) const

inlineinherited

Get a 2-vector with [NROWS NCOLS] (as in MATLAB command size(x))

Definition at line 304 of file CMatrixTemplate.h.

◆ swap()

void mrpt::math::CMatrixTemplate< bool >::swap ( CMatrixTemplate< T > & o )

inlineinherited

Swap with another matrix very efficiently (just swaps a pointer and two integer values).

Definition at line 166 of file CMatrixTemplate.h.

Member Data Documentation

◆ m_Cols

size_t mrpt::math::CMatrixTemplate< bool >::m_Cols

protectedinherited

Definition at line 85 of file CMatrixTemplate.h.

◆ m_Rows

size_t mrpt::math::CMatrixTemplate< bool >::m_Rows

protectedinherited

Definition at line 85 of file CMatrixTemplate.h.

◆ m_Val

bool ** mrpt::math::CMatrixTemplate< bool >::m_Val

protectedinherited

Definition at line 84 of file CMatrixTemplate.h.

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ const_reference

◆ difference_type

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ CMatrixBool() [1/2]

◆ CMatrixBool() [2/2]

Member Function Documentation

◆ appendCol()

◆ appendRow()

◆ ASSERT_ENOUGHROOM()

◆ cols()

◆ extractCol() [1/2]

◆ extractCol() [2/2]

◆ extractColumns()

◆ extractRows()

◆ extractSubmatrix() [1/2]

◆ extractSubmatrix() [2/2]

◆ fillAll()

◆ get_unsafe() [1/2]

◆ get_unsafe() [2/2]

◆ get_unsafe_row() [1/2]

◆ get_unsafe_row() [2/2]

◆ getAsVector()

◆ insertCol()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ operator=()

◆ realloc()

◆ resize()

◆ rows()

◆ set_unsafe()

◆ setSize()

◆ size()

◆ swap()

Member Data Documentation

◆ m_Cols

◆ m_Rows

◆ m_Val