functor_extract_submatrices Class Reference

Function operator class to extract the submatrices from a unitary. More...

#include <Sub_Matrix_Decomposition_Cost_Function.h>

Inheritance diagram for functor_extract_submatrices:

Public Member Functions
	functor_extract_submatrices (Matrix &matrix_in, std::vector< Matrix, tbb::cache_aligned_allocator< Matrix >> *submatrices_in)
	Constructor of the class. More...
void	operator() (tbb::blocked_range< int > r) const
	Operator to extract the sumbatrix indexed by submtx_idx. More...
void	print (const std::stringstream &sstream, int verbose_level=1) const
	Call to print output messages in the function of the verbosity level. More...
void	set_debugfile (std::string debugfile)
	Call to set the debugfile name. More...
void	set_verbose (int verbose_in)
	Call to set the verbose attribute. More...

Public Attributes
bool	debug
	Logical variable. Set true to write output messages to the 'debug.txt' file. More...
std::string	debugfile_name
	String variable. Set the debug file name. More...
int	verbose
	Set the verbosity level of the output messages. More...

Protected Attributes
Matrix	matrix
	The matrix from which submatrices would be extracted. More...
std::vector< Matrix, tbb::cache_aligned_allocator< Matrix > > *	submatrices
	preallocated container storing the submatrices More...

Detailed Description

Function operator class to extract the submatrices from a unitary.

Definition at line 46 of file Sub_Matrix_Decomposition_Cost_Function.h.

Constructor & Destructor Documentation

functor_extract_submatrices()

functor_extract_submatrices::functor_extract_submatrices	(	Matrix &	matrix_in,
		std::vector< Matrix, tbb::cache_aligned_allocator< Matrix >> *	submatrices_in
	)

Constructor of the class.

Parameters

matrix_in	The square shaped complex matrix from which the cost function is calculated during the submatrix decomposition process.
submatrices_in	Preallocated arrays for the submatrices

Returns

Returns with the instance of the class.

Parameters

matrix_in	The square shaped complex matrix from which the cost function is calculated during the submatrix decomposition process.
matrix_size_in	The number rows in the matrix matrix_in
submatrices_in	Preallocated arrays for the submatrices

Returns

Returns with the instance of the class.

Definition at line 87 of file Sub_Matrix_Decomposition_Cost_Function.cpp.

Member Function Documentation

operator()()

void functor_extract_submatrices::operator()

(

tbb::blocked_range< int >

r

)

const

Operator to extract the sumbatrix indexed by submtx_idx.

Operator to extract the submatrix indexed by submtx_idx.

Parameters

r	A range of indices labeling the given submatrix to be extracted

Definition at line 99 of file Sub_Matrix_Decomposition_Cost_Function.cpp.

Here is the call graph for this function:

print()

void logging::print ( const std::stringstream &  sstream, int  verbose_level = 1  ) const

inherited

Call to print output messages in the function of the verbosity level.

Parameters

sstream	The stringstream input to store the output messages.
verbose_level	Integer input. High level means write more to the standart output, 0 means write nothing. The default value is set to 1.

Definition at line 55 of file logging.cpp.

set_debugfile()

void logging::set_debugfile ( std::string  debugfile )

inherited

Call to set the debugfile name.

Parameters

debugfile

String variable. Set the debugfile name.

Definition at line 95 of file logging.cpp.

Here is the caller graph for this function:

set_verbose()

void logging::set_verbose ( int  verbose_in )

inherited

Call to set the verbose attribute.

Parameters

verbose_in

Integer variable. Set the number to specify the verbosity level for output messages.

Definition at line 85 of file logging.cpp.

Here is the caller graph for this function:

Member Data Documentation

debug

bool logging::debug

inherited

Logical variable. Set true to write output messages to the 'debug.txt' file.

Definition at line 53 of file logging.h.

debugfile_name

std::string logging::debugfile_name

inherited

String variable. Set the debug file name.

Definition at line 56 of file logging.h.

matrix

Matrix functor_extract_submatrices::matrix

protected

The matrix from which submatrices would be extracted.

Definition at line 51 of file Sub_Matrix_Decomposition_Cost_Function.h.

submatrices

std::vector<Matrix, tbb::cache_aligned_allocator<Matrix> >* functor_extract_submatrices::submatrices

protected

preallocated container storing the submatrices

Definition at line 53 of file Sub_Matrix_Decomposition_Cost_Function.h.

verbose

int logging::verbose

inherited

Set the verbosity level of the output messages.

Definition at line 50 of file logging.h.

---

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

• Sub_Matrix_Decomposition_Cost_Function.h
• Sub_Matrix_Decomposition_Cost_Function.cpp