Inteface of Matrix class. More...

#include <matrix_interface.hpp>

Public Types
typedef C	value_type
	`double` or `complex` More...

typedef int	comm_type
	Set `MPI_Comm` for MPI programm. More...

Public Member Functions
	Matrix ()
	Constructor of a size-zero matrix. More...

	Matrix (const comm_type &comm)
	Constructor of a size-zero matrix. More...

	Matrix (size_t n_row, size_t n_col)
	Constructor of a (n_row, n_col) matrix. More...

	Matrix (const comm_type &comm, size_t n_row, size_t n_col)
	Constructor of a (n_row, n_col) matrix. More...

void	init (size_t n_row, size_t n_col)

const comm_type &	get_comm () const
	Return the MPI communicator. More...

int	get_comm_size () const
	Return the size of the MPI communicator. More...

int	get_comm_rank () const
	Return the MPI rank. More...

void	print_info (std::ostream &) const

const C &	operator[] (size_t i) const
	Const array subscript operator. More...

C &	operator[] (size_t i)
	Array subscript operator. More...

const C *	head () const

C *	head ()

size_t	local_size () const
	Return the number of elements in this process. More...

void	global_index (size_t i, size_t &g_row, size_t &g_col) const

bool	local_index (size_t g_row, size_t g_col, size_t &i) const

void	local_position (size_t g_row, size_t g_col, int &comm_rank, size_t &lindex) const

size_t	local_row_size () const

size_t	local_col_size () const

size_t	local_row_index (size_t lindex) const

size_t	local_col_index (size_t lindex) const

size_t	global_row_index (size_t lindex_row) const

size_t	global_col_index (size_t lindex_col) const

Matrix &	operator+= (const Matrix &rhs)

Matrix &	operator-= (const Matrix &rhs)

Matrix &	operator*= (C rhs)

Matrix &	operator/= (C rhs)

template<typename UnaryOperation >
Matrix &	map (UnaryOperation op)

std::vector< C >	flatten ()
	Return the flattened vector. More...

void	barrier () const
	Wrapper of MPI_Barrier. More...

C	allreduce_sum (C value) const
	Return the summation of a scalar. Every processes returns the same value. More...

template<typename D >
void	bcast (D *buffer, int count, int root) const
	Wrapper of MPI_Bcast. More...

void	prep_local_to_global () const
	Preprocess for fast conversion from local index to global one. More...

void	prep_global_to_local () const
	Preprocess for fast conversion from local index to global one. More...

void	save_index (const std::string &filename) const

Static Public Attributes
constexpr static size_t	matrix_type_tag = MATRIX_TYPE_TAG_INTERFACE

constexpr static char *	matrix_type_name = (char*)"Interface"

Related Functions
(Note that these are not member functions.)
template<typename C >
int	matrix_eigh (Matrix< C > &a, std::vector< double > &s)
	Eigenvalues of a hermite (symmetric) matrix. More...

Detailed Description

template<typename C>
class mptensor::matrix_interface::Matrix< C >

Inteface of Matrix class.

This class shows the list of members, which should be implemented in a Matrix class.

Warning: A Matrix class is not necessary to inherint this class because we use duck typing.

Template Parameters

C	type of elements (double or complex).

Member Typedef Documentation

◆ comm_type

template<typename C >

typedef int mptensor::matrix_interface::Matrix< C >::comm_type

Set MPI_Comm for MPI programm.

◆ value_type

template<typename C >

typedef C mptensor::matrix_interface::Matrix< C >::value_type

double or complex

Constructor & Destructor Documentation

◆ Matrix() [1/4]

template<typename C >

mptensor::matrix_interface::Matrix< C >::Matrix< C > ( )

Constructor of a size-zero matrix.

Note: MPI communicator is set to MPI_COMM_WORLD or MPI_COMM_SELF.

◆ Matrix() [2/4]

template<typename C >

mptensor::matrix_interface::Matrix< C >::Matrix< C > ( const comm_type & comm )

explicit

Constructor of a size-zero matrix.

Parameters

[in] comm MPI communicator.

◆ Matrix() [3/4]

template<typename C >

mptensor::matrix_interface::Matrix< C >::Matrix< C >	(	size_t	n_row,
		size_t	n_col
	)

Constructor of a (n_row, n_col) matrix.

Parameters

[in]	n_row	size of row.
[in]	n_col	size of column.

Note: MPI communicator is set to MPI_COMM_WORLD or MPI_COMM_SELF.

◆ Matrix() [4/4]

template<typename C >

mptensor::matrix_interface::Matrix< C >::Matrix< C >	(	const comm_type &	comm,
		size_t	n_row,
		size_t	n_col
	)

Constructor of a (n_row, n_col) matrix.

Parameters

[in]	comm	MPI communicator.
[in]	n_row	size of row.
[in]	n_col	size of column.

Member Function Documentation

◆ allreduce_sum()

template<typename C >

C mptensor::matrix_interface::Matrix< C >::allreduce_sum ( C value ) const

Return the summation of a scalar. Every processes returns the same value.

Returns: The summation of val.

◆ barrier()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::barrier ( ) const

Wrapper of MPI_Barrier.

◆ bcast()

template<typename C >

template<typename D >

void mptensor::matrix_interface::Matrix< C >::bcast	(	D *	buffer,
		int	count,
		int	root
	)		const

Wrapper of MPI_Bcast.

Parameters

[in]	buffer	Starting address of buffer.
[in]	count	Number of entries in buffer.
[in]	root	Rank of broadcast root.

◆ flatten()

template<typename C >

std::vector< C > mptensor::matrix_interface::Matrix< C >::flatten ( )

Return the flattened vector.

Returns: the flattened vector. (global)

◆ get_comm()

template<typename C >

const Matrix< C >::comm_type & mptensor::matrix_interface::Matrix< C >::get_comm ( ) const

Return the MPI communicator.

Returns: MPI communicator.

◆ get_comm_rank()

template<typename C >

int mptensor::matrix_interface::Matrix< C >::get_comm_rank ( ) const

Return the MPI rank.

Returns: the rank of process.

◆ get_comm_size()

template<typename C >

int mptensor::matrix_interface::Matrix< C >::get_comm_size ( ) const

Return the size of the MPI communicator.

Returns: The size of the MPI communicator.

◆ global_col_index()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::global_col_index ( size_t lindex_col ) const

◆ global_index()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::global_index	(	size_t	i,
		size_t &	g_row,
		size_t &	g_col
	)		const

◆ global_row_index()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::global_row_index ( size_t lindex_row ) const

◆ head() [1/2]

template<typename C >

C* mptensor::matrix_interface::Matrix< C >::head ( )

◆ head() [2/2]

template<typename C >

const C* mptensor::matrix_interface::Matrix< C >::head ( ) const

◆ init()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::init	(	size_t	n_row,
		size_t	n_col
	)

◆ local_col_index()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::local_col_index ( size_t lindex ) const

◆ local_col_size()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::local_col_size ( ) const

◆ local_index()

template<typename C >

bool mptensor::matrix_interface::Matrix< C >::local_index	(	size_t	g_row,
		size_t	g_col,
		size_t &	i
	)		const

◆ local_position()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::local_position	(	size_t	g_row,
		size_t	g_col,
		int &	comm_rank,
		size_t &	lindex
	)		const

◆ local_row_index()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::local_row_index ( size_t lindex ) const

◆ local_row_size()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::local_row_size ( ) const

◆ local_size()

template<typename C >

size_t mptensor::matrix_interface::Matrix< C >::local_size ( ) const

Return the number of elements in this process.

Returns: Size of local storage.

◆ map()

template<typename C >

template<typename UnaryOperation >

Matrix& mptensor::matrix_interface::Matrix< C >::map ( UnaryOperation op )

◆ operator*=()

template<typename C >

Matrix& mptensor::matrix_interface::Matrix< C >::operator*= ( C rhs )

◆ operator+=()

template<typename C >

Matrix& mptensor::matrix_interface::Matrix< C >::operator+= ( const Matrix< C > & rhs )

◆ operator-=()

template<typename C >

Matrix& mptensor::matrix_interface::Matrix< C >::operator-= ( const Matrix< C > & rhs )

◆ operator/=()

template<typename C >

Matrix& mptensor::matrix_interface::Matrix< C >::operator/= ( C rhs )

◆ operator[]() [1/2]

template<typename C >

C & mptensor::matrix_interface::Matrix< C >::operator[] ( size_t i )

Array subscript operator.

Attention: This function does not check validity of local index.

◆ operator[]() [2/2]

template<typename C >

const C & mptensor::matrix_interface::Matrix< C >::operator[] ( size_t i ) const

Const array subscript operator.

Attention: This function does not check validity of local index.

◆ prep_global_to_local()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::prep_global_to_local ( ) const

Preprocess for fast conversion from local index to global one.

◆ prep_local_to_global()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::prep_local_to_global ( ) const

Preprocess for fast conversion from local index to global one.

◆ print_info()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::print_info ( std::ostream & ) const

◆ save_index()

template<typename C >

void mptensor::matrix_interface::Matrix< C >::save_index ( const std::string & filename ) const

Friends And Related Function Documentation

◆ matrix_eigh()

template<typename C >

int matrix_eigh	(	Matrix< C > &	a,
		std::vector< double > &	s
	)

Parameters

[in]	a	The hermite or symmetric matrix. On exit, it may be destroyed.
[out]	s	The eigenvalues in ascending order.

Returns: information from the library.

Member Data Documentation

◆ matrix_type_name

template<typename C >

constexpr static char* mptensor::matrix_interface::Matrix< C >::matrix_type_name = (char*)"Interface"

staticconstexpr

◆ matrix_type_tag

template<typename C >

constexpr static size_t mptensor::matrix_interface::Matrix< C >::matrix_type_tag = MATRIX_TYPE_TAG_INTERFACE

staticconstexpr

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

/home/runner/work/mptensor/mptensor/include/mptensor/matrix_interface/matrix_interface.hpp
/home/runner/work/mptensor/mptensor/include/mptensor/matrix_interface/matrix_interface_doc.hpp

Public Types

Public Member Functions

Static Public Attributes

Related Functions

Detailed Description

template<typename C> class mptensor::matrix_interface::Matrix< C >

Member Typedef Documentation

◆ comm_type

◆ value_type

Constructor & Destructor Documentation

◆ Matrix() [1/4]

◆ Matrix() [2/4]

◆ Matrix() [3/4]

◆ Matrix() [4/4]

Member Function Documentation

◆ allreduce_sum()

◆ barrier()

◆ bcast()

◆ flatten()

◆ get_comm()

◆ get_comm_rank()

◆ get_comm_size()

◆ global_col_index()

◆ global_index()

◆ global_row_index()

◆ head() [1/2]

◆ head() [2/2]

◆ init()

◆ local_col_index()

◆ local_col_size()

◆ local_index()

◆ local_position()

◆ local_row_index()

◆ local_row_size()

◆ local_size()

◆ map()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ prep_global_to_local()

◆ prep_local_to_global()

◆ print_info()

◆ save_index()

Friends And Related Function Documentation

◆ matrix_eigh()

Member Data Documentation

◆ matrix_type_name

◆ matrix_type_tag

template<typename C>
class mptensor::matrix_interface::Matrix< C >