Base class for Eigen-based matrices. More...

#include <eigen_base.hpp>

Inheritance diagram for bem::EigenMatrixBase< T, MatrixType >:

Detailed Description

template<typename T, typename MatrixType>
class bem::EigenMatrixBase< T, MatrixType >

Base class for Eigen-based matrices.

Template Parameters

T	- Data type to be stored in the matrix (e.g., float, double, std::complex).
MatrixType	- Specific Eigen matrix type.

Definition at line 46 of file eigen_base.hpp.

Constructor & Destructor Documentation

◆ EigenMatrixBase() [1/2]

template<typename T , typename MatrixType >

bem::EigenMatrixBase< T, MatrixType >::EigenMatrixBase	(	Index	rows,
		Index	cols
	)

inline

Constructs an EigenMatrixBase object with a specified number of rows and columns.

Parameters

[in]	rows	- Number of rows.
[in]	cols	- Number of columns.

Definition at line 55 of file eigen_base.hpp.

◆ EigenMatrixBase() [2/2]

template<typename T , typename MatrixType >

bem::EigenMatrixBase< T, MatrixType >::EigenMatrixBase ( )

inline

Constructs an empty zero-size EigenMatrixBase object.

Definition at line 66 of file eigen_base.hpp.

Member Function Documentation

◆ set_block()

template<typename T , typename MatrixType >

virtual void bem::EigenMatrixBase< T, MatrixType >::set_block	(	const MatrixBase< T > &	x,
		Index	row_start,
		Index	col_start,
		const T &	a = `T(1)`
	)

pure virtual

Sets a block of values in this matrix to the values of a given matrix, starting at a given position.

Parameters

[in]	x	- Matrix to insert.
[in]	row_start	- Starting row index for the block.
[in]	col_start	- Starting column index for the block.
[in]	a	- Scalar to multiply the values of `x` before inserting (optional).

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ add_block()

template<typename T , typename MatrixType >

virtual void bem::EigenMatrixBase< T, MatrixType >::add_block	(	const MatrixBase< T > &	x,
		Index	row_start,
		Index	col_start,
		const T &	a = `T(1)`
	)

pure virtual

Adds a block of values to this matrix from the values of a given matrix, starting at a given position.

Parameters

[in]	x	- Matrix whose values should be added to a block of this matrix.
[in]	row_start	- Starting row index for the block.
[in]	col_start	- Starting column index for the block.
[in]	a	- Scalar to multiply the values of `x` before adding (optional).

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ get_block()

template<typename T , typename MatrixType >

virtual void bem::EigenMatrixBase< T, MatrixType >::get_block	(	MatrixBase< T > &	x,
		Index	row_start,
		Index	col_start,
		Index	b_rows,
		Index	b_cols
	)		const

pure virtual

Retrieves a block of values from this matrix.

Parameters

[out]	x	- Matrix to store the retrieved block of values.
[in]	row_start	- Starting row index for the block.
[in]	col_start	- Starting column index for the block.
[in]	b_rows	- Number of rows in the block to retrieve.
[in]	b_cols	- Number of columns in the block to retrieve.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ raw_matrix() [1/2]

template<typename T , typename MatrixType >

MatrixType & bem::EigenMatrixBase< T, MatrixType >::raw_matrix ( )

inline

Returns a writable reference to the underlying raw matrix - use with caution.

Definition at line 120 of file eigen_base.hpp.

◆ raw_matrix() [2/2]

template<typename T , typename MatrixType >

const MatrixType & bem::EigenMatrixBase< T, MatrixType >::raw_matrix ( ) const

inline

Returns a read-only reference to the underlying raw matrix.

Definition at line 129 of file eigen_base.hpp.

◆ set_raw_matrix()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_raw_matrix ( const MatrixType & matrix )

inline

Sets the underlying raw matrix by copying over data from a given matrix.

Parameters

[in] matrix - The raw matrix to set.

Definition at line 139 of file eigen_base.hpp.

◆ bind_raw_matrix()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::bind_raw_matrix ( std::shared_ptr< MatrixType > matrix )

inline

Binds the underlying raw matrix to the data pointed at by a given matrix pointer.

Parameters

[in] matrix - Pointer to the raw matrix to be bound.

The purpose of this method is to allow creating an external Eigen matrix of type MatrixType, and then transferring ownership of that matrix to this object, but without copying over the underlying data, unlike set_raw_matrix().

Definition at line 154 of file eigen_base.hpp.

◆ num_rows()

template<typename T , typename MatrixType >

Index bem::EigenMatrixBase< T, MatrixType >::num_rows ( ) const

inlineoverridevirtual

Returns the total number of rows in the matrix.

Returns: Number of rows.

Implements bem::MatrixBase< T >.

Definition at line 165 of file eigen_base.hpp.

◆ num_cols()

template<typename T , typename MatrixType >

Index bem::EigenMatrixBase< T, MatrixType >::num_cols ( ) const

inlineoverridevirtual

Returns the total number of rows in the matrix.

Returns: Number of rows.

Implements bem::MatrixBase< T >.

Definition at line 175 of file eigen_base.hpp.

◆ size()

template<typename T , typename MatrixType >

Index bem::EigenMatrixBase< T, MatrixType >::size ( ) const

inlineoverridevirtual

Returns the size (rows * cols) of the matrix.

Returns: Size (rows * cols).

Reimplemented from bem::MatrixBase< T >.

Definition at line 185 of file eigen_base.hpp.

◆ resize()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::resize	(	Index	rows,
		Index	cols
	)

inlineoverridevirtual

Resizes the matrix to a new number of rows and columns.

Parameters

[in]	rows	- New number of rows.
[in]	cols	- New number of columns.

Implements bem::MatrixBase< T >.

Definition at line 196 of file eigen_base.hpp.

◆ clear()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::clear ( )

inlineoverridevirtual

Clears all data in the matrix and sets its size to 0.

Implements bem::MatrixBase< T >.

Definition at line 207 of file eigen_base.hpp.

◆ set_zero()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_zero ( )

inlineoverridevirtual

Sets all matrix entries to zero.

Implements bem::MatrixBase< T >.

Definition at line 217 of file eigen_base.hpp.

◆ set_identity()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_identity ( )

inlineoverridevirtual

Sets the matrix to identity (ones along the diagonal).

Reimplemented from bem::MatrixBase< T >.

Definition at line 227 of file eigen_base.hpp.

◆ set_transpose()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_transpose ( const MatrixBase< T > & x )

inline

Computes \( \mathbf{M} = \mathbf{X}^T \) where \( \mathbf{M} \) is this matrix, \( \mathbf{X} \) is a given matrix, and \( \mathbf{X}^T \) is its transpose.

Parameters

[in] x - Matrix to transpose.

Definition at line 240 of file eigen_base.hpp.

◆ get_diagonal()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::get_diagonal ( MatrixBase< T > & x ) const

inline

Retrieves matrix values on the diagonal, zeroing out all other entries.

Parameters

[out] x - Diagonal matrix.

Definition at line 252 of file eigen_base.hpp.

◆ add_ax()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::add_ax	(	const MatrixBase< T > &	x,
		const T &	a = `T(1)`
	)

inlineoverridevirtual

Computes \( \mathbf{M} = \mathbf{M} + a\mathbf{X} \) where \( \mathbf{M} \) is this matrix, \( a \) is a scalar, and \( \mathbf{X} \) is a matrix.

Parameters

[in]	x	- Matrix to scale and add, must have the same dimensions as this matrix.
[in]	a	- Scalar which which to scale `x`.

Implements bem::MatrixBase< T >.

Definition at line 266 of file eigen_base.hpp.

◆ set_axpby()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_axpby	(	const MatrixBase< T > &	x,
		const MatrixBase< T > &	y,
		const T &	a = `T(1)`,
		const T &	b = `T(1)`
	)

inline

Computes \( \mathbf{M} = a\mathbf{X} + b\mathbf{Y} \) where \( \mathbf{M} \) is this matrix, \( a \) and \( b \) are scalars, and \( \mathbf{X} \) and \( \mathbf{Y} \) are matrices.

Parameters

[in]	x	- First matrix to scale and add, must have the same dimensions as `y`.
[in]	y	- Second matrix to scale and add, must have the same dimensions as `x`.
[in]	a	- Scalar which which to scale `x`.
[in]	b	- Scalar which which to scale `y`.

Definition at line 282 of file eigen_base.hpp.

◆ set_mat_mul()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::set_mat_mul	(	const MatrixBase< T > &	x,
		const MatrixBase< T > &	y,
		const T &	a = `T(1)`
	)

inline

Computes \( \mathbf{M} = a\mathbf{X}\mathbf{Y} \) where \( \mathbf{M} \) is this matrix, \( a \) is a scalar, and \( \mathbf{X} \) and \( \mathbf{Y} \) are matrices.

Parameters

[in]	x	- First matrix to multiply, must have the same number of columns as `y` has rows.
[in]	y	- Second matrix to multiply , must have the same number of rows as `x` has columns.
[in]	a	- Scalar which which to scale the product of `x` and `y`.

Definition at line 298 of file eigen_base.hpp.

◆ add_mat_mul()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::add_mat_mul	(	const MatrixBase< T > &	x,
		const MatrixBase< T > &	y,
		const T &	a = `T(1)`
	)

inline

Computes \( \mathbf{M} = \mathbf{M} + a\mathbf{X}\mathbf{Y} \) where \( \mathbf{M} \) is this matrix, \( a \) is a scalar, and \( \mathbf{X} \) and \( \mathbf{Y} \) are matrices.

Parameters

[in]	x	- First matrix to multiply, must have the same number of columns as `y` has rows.
[in]	y	- Second matrix to multiply , must have the same number of rows as `x` has columns.
[in]	a	- Scalar which which to scale the product of `x` and `y`.

Definition at line 314 of file eigen_base.hpp.

◆ mat_solve_iterative()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::mat_solve_iterative	(	MatrixBase< T > &	x,
		const MatrixBase< T > &	b,
		const Float	tol = `1e-3`
	)

inline

Solves \( \mathbf{M}\mathbf{X} = \mathbf{B} \) for matrix \( \mathbf{X} \) with an iterative solver, where \( \mathbf{M} \) is this matrix, and \( \mathbf{B} \) is a given right-hand side matrix.

Parameters

[out]	x	- Solution.
[in]	b	- Right-hand side matrix, must have the same number of rows as this matrix.
[in]	tol	- Tolerance for convergence (optional).

Definition at line 332 of file eigen_base.hpp.

◆ mat_solve_gmres()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::mat_solve_gmres	(	MatrixBase< T > &	x,
		const MatrixBase< T > &	b,
		const Float	tol = `1e-3`,
		const Index	restart = `100`
	)

inline

Solves \( \mathbf{M}\mathbf{X} = \mathbf{B} \) for matrix \( \mathbf{X} \) with the GMRES iterative solver, where \( \mathbf{M} \) is this matrix, and \( \mathbf{B} \) is a given right-hand side matrix.

Parameters

[out]	x	- Solution.
[in]	b	- Right-hand side matrix, must have the same number of rows as this matrix.
[in]	tol	- Tolerance for convergence (optional).
[in]	restart	- Restart iteration at which the Krylov subspace is discarded (optional).

Definition at line 349 of file eigen_base.hpp.

◆ mat_solve_bicgstab()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::mat_solve_bicgstab	(	MatrixBase< T > &	x,
		const MatrixBase< T > &	b,
		const Float	tol = `1e-3`
	)

inline

Solves \( \mathbf{M}\mathbf{X} = \mathbf{B} \) for matrix \( \mathbf{X} \) with the BiCGSTAB iterative solver, where \( \mathbf{M} \) is this matrix, and \( \mathbf{B} \) is a given right-hand side matrix.

Parameters

[out]	x	- Solution.
[in]	b	- Right-hand side matrix, must have the same number of rows as this matrix.
[in]	tol	- Tolerance for convergence (optional).

Definition at line 390 of file eigen_base.hpp.

◆ cond()

template<typename T , typename MatrixType >

Float bem::EigenMatrixBase< T, MatrixType >::cond ( ) const

inline

Computes the condition number (ratio of largest to smallest singular value) of the matrix.

Returns: Condition number.

Definition at line 424 of file eigen_base.hpp.

◆ print()

template<typename T , typename MatrixType >

void bem::EigenMatrixBase< T, MatrixType >::print ( const std::string name = "matrix" ) const

inlineoverridevirtual

Prints the matrix to the terminal in a formatted manner.

Reimplemented from bem::MatrixBase< T >.

Definition at line 440 of file eigen_base.hpp.

◆ value()

template<typename T >

virtual T bem::MatrixBase< T >::value	(	Index	row,
		Index	col
	)		const

pure virtualinherited

Returns the matrix value at the specified row and column.

Parameters

[in]	row	- Row index.
[in]	col	- Column index.

Returns: Value at the specified position in the matrix.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ set_value()

template<typename T >

virtual void bem::MatrixBase< T >::set_value	(	Index	row,
		Index	col,
		const T &	a
	)

pure virtualinherited

Sets the matrix value at the specified row and column.

Parameters

[in]	row	- Row index.
[in]	col	- Column index.
[in]	a	- Value to set.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ scale()

template<typename T >

virtual void bem::MatrixBase< T >::scale ( const T & a )

pure virtualinherited

Scales all matrix entries by a given value.

Parameters

[in] a - Value by which to scale.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ data() [1/2]

template<typename T >

virtual const T * bem::MatrixBase< T >::data ( ) const

pure virtualinherited

Returns a read-only pointer to the underlying raw data.

Returns: Read-only pointer to the raw data.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ data() [2/2]

template<typename T >

virtual T * bem::MatrixBase< T >::data ( )

pure virtualinherited

Returns a writable pointer to the underlying raw data - use with care.

Returns: Writable pointer to the raw data.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ mat_solve()

template<typename T >

virtual void bem::MatrixBase< T >::mat_solve	(	MatrixBase< T > &	x,
		const MatrixBase< T > &	b
	)

pure virtualinherited

Solves \( \mathbf{M}\mathbf{X} = \mathbf{B} \) for matrix \( \mathbf{X} \) with a direct solver, where \( \mathbf{M} \) is this matrix, and \( \mathbf{B} \) is a given right-hand side matrix.

Parameters

[out]	x	- Solution.
[in]	b	- Right-hand side matrix, must have the same number of rows as this matrix.

Implemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

◆ add_value()

template<typename T >

virtual void bem::MatrixBase< T >::add_value	(	Index	row,
		Index	col,
		const T &	a
	)

inlinevirtualinherited

Adds to the matrix value at the specified row and column.

Parameters

[in]	row	- Row index.
[in]	col	- Column index.
[in]	a	- Value to add.

Reimplemented in bem::EigenDenseMatrix< T, StorageOrder >, and bem::EigenSparseMatrix< T, StorageOrder >.

Definition at line 154 of file base.hpp.

◆ preallocate() [1/2]

template<typename T >

virtual void bem::MatrixBase< T >::preallocate ( const std::vector< Index > & nnz )

inlinevirtualinherited

Preallocates memory for a given number of non-zero values per row.

Parameters

[in] nnz - Vector containing the number of non-zero values for each row.

Reimplemented in bem::EigenSparseMatrix< T, StorageOrder >.

Definition at line 165 of file base.hpp.

◆ preallocate() [2/2]

template<typename T >

virtual void bem::MatrixBase< T >::preallocate ( Index num_entries )

inlinevirtualinherited

Preallocates memory for a given total number of non-zero values.

Parameters

[in] num_entries - Total number of non-zero values.

Reimplemented in bem::EigenSparseMatrix< T, StorageOrder >.

Definition at line 172 of file base.hpp.

◆ assemble()

template<typename T >

virtual void bem::MatrixBase< T >::assemble ( )

inlinevirtualinherited

Assembles cached data into the matrix.

Reimplemented in bem::EigenSparseMatrix< T, StorageOrder >.

Definition at line 178 of file base.hpp.

◆ write_binary()

template<typename T >

virtual void bem::MatrixBase< T >::write_binary ( const std::string name = "matrix" ) const

inlinevirtualinherited

Writes the matrix to a binary file.

Definition at line 196 of file base.hpp.

◆ read_binary()

template<typename T >

virtual void bem::MatrixBase< T >::read_binary ( const std::string name = "matrix" )

inlinevirtualinherited

Reads the matrix from a binary file.

Definition at line 211 of file base.hpp.

Member Data Documentation

◆ matrix_

template<typename T , typename MatrixType >

std::shared_ptr<MatrixType> bem::EigenMatrixBase< T, MatrixType >::matrix_ = nullptr

protected

Definition at line 451 of file eigen_base.hpp.

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

source/matrix/eigen_base.hpp