This class is multi levels toeplitz matrix. The matrix at level k is composed by $ 2.n_k-1 $ toeplitz block matrices: More...

#include <MATH_MultiLevelsToeplitzMatrix.h>

Inheritance diagram for MATH_MultiLevelsToeplitzMatrix:

[legend]

Collaboration diagram for MATH_MultiLevelsToeplitzMatrix:

[legend]

Public Member Functions
virtual SP::MATH_MultiLevelsToeplitzMatrix	NewInstance () const =0
	new instance More...

const tFFTWComplex &	operator() (const tUIndex &i, const tUIndex &j) const
	get the value of the matrix at row i and column j More...

tFFTWComplex &	operator() (const tUIndex &i, const tUIndex &j)
	get the value of the matrix at row i and column j More...

virtual void	copy (const MATH_MultiLevelsToeplitzMatrix &mat)
	copy the instance More...

virtual void	clear ()
	clear the multi level toeplitz matrix More...

virtual void	setLeafBlockDimension (const tUIndex &n)
	set the dimension of leaf block More...

virtual void	setLevels (const tUSInt &levelsNumber, const tUIndex levels[], const tUIndex &nD)
	set the levels of the matrix More...

void	setLevels (const tUSInt &levelsNumber, const tUIndex levels[])
	set the levels of the matrix More...

virtual tULLInt	getMemorySize () const
	return the memory size in byte More...

tReal	getRealValue (const tUIndex &i, const tUIndex &j) const
	get the real value at row i and column j More...

const tUIndex &	getDimension () const
	get the dimension of the matrix More...

const tUIndex &	getRowsNumber () const
	get the dimension of the matrix More...

const tUIndex &	getColumnsNumber () const
	get the dimension of the matrix More...

FFTW_ComplexArray &	getValues ()
	get the values of the matrix More...

const FFTW_ComplexArray &	getValues () const
	get the values of the matrix More...

const tFFTWComplex *	getLeafBlockValues (const tIndex indices[]) const
	get the values of the leaf block More...

tFFTWComplex *	getLeafBlockValues (const tIndex indices[])
	get the values of the leaf block More...

const CORE_UIndexArray &	getLevels () const
	get the level of the matrix More...

tUSInt	getLevelsNumber () const
	get the number of levels of the matrix More...

const tUIndex &	getCanonicalSpaceSize () const
	get canonical space size More...

tUIndex	getLeafBlockSize () const
	return the size of the leaf block matrix More...

const tUIndex &	getLeafBlockDimension () const
	return the dimension of the leaf block matrix More...

tUIndex	getBlocksNumber () const
	get the blocks number More...

const tUIndex &	getBlocksNumberPerRow (const tUSInt &l) const
	get the blocks number per row or column at the level More...

tUIndex	getBlocksNumber (const tUIndex &l) const
	get the blocks number at the level More...

const tFlag &	getSpace () const
	get the space of the matrix More...

const MATH_LeafBlockMatrixStorage &	getStorage () const
	get the storage of the leaf matrices More...

MATH_LeafBlockMatrixStorage &	getStorage ()
	get the storage of the leaf matrices More...

tUIndex	getIndex (const tUIndex &i, const tUIndex &j) const
	return the index in values of the matrix value at row i and column j More...

tUIndex	getToeplitzBlockIndex (const tUSInt &nLevels, const tUIndex N[], const tIndex I[]) const
	get the block index corresponding to indices More...

tUIndex	getToeplitzBlockIndex (const tIndex I[]) const
	get the block index corresponding to indices More...

void	projection (const tFlag &space)
	make the projection in the space More...

virtual void	vectorProduct (const CORE_RealArray &X, CORE_RealArray &Y) const
	do the vector product of the circular matrix C with Y by an FFT method More...

virtual void	vectorProduct (const tUIndex &N, const tReal X, tReal Y) const =0
	do the vector product of the circular matrix C with Y by an FFT method More...

virtual tString	toString () const
	return string More...

void	getSharedPointer (SP::CORE_Object &p)
	get the shared pointer of this class into p More...

void	getSharedPointer (SPC::CORE_Object &p) const
	get the shared pointer of this class into p More...

tString	getClassName () const
	return the class name of the object More...

tString	getIdentityString () const
	return the identity string of the object of the form className_at_address More...

tString	getPointerAddress () const
	return the identity string of the object More...

template<class T >
tBoolean	isInstanceOf () const
	test if the clas T is an instance of this class More...

tBoolean	isInstanceOf (const tString &name) const
	test if the object is an instance of className More...

Static Public Member Functions
static void	setIsMemoryChecked (const tBoolean &v)
	set if the memory checking is used More...

static void	setOut (SP::CORE_Out out)
	set the output stream More...

static void	resetOut ()
	reset the output stream More...

static void	setThread (SP::CORE_Thread thread)
	set the thread More...

static void	resetThread ()
	reset the output stream More...

static CORE_Out &	out ()
	get the output More...

static SP::CORE_Out	getOut ()
	get the output More...

static CORE_Thread &	getThread ()
	get the profilier More...

static const tBoolean &	isMemoryChecked ()
	get if the memory checking is used More...

static tString	getClassName (const tString &identityString)
	return the class name of the object More...

template<class T >
static tString	getTypeName ()
	get type name More...

static tBoolean	is64Architecture ()
	return true if the machine is a 64 bits machine More...

static tBoolean	is32Architecture ()
	return true if the machine is a 32 bits machine More...

static tString	pointer2String (const void *obj)
	return the string representation of a pointer More...

static void	printObjectsInMemory (ostream &f)
	print object in memory More...

static void	printObjectsInMemory ()
	print object in memory in the standart output More...

static tChar	getMaxChar ()
	get the max value for tChar type More...

static tChar	getMinChar ()
	get the min value for tChar type More...

static tUChar	getMaxUChar ()
	get the max value for tUChar type More...

static tUChar	getMinUChar ()
	get the min value for tUChar type More...

static tSInt	getMaxSInt ()
	get the max value for tSInt type More...

static tSInt	getMinSInt ()
	get the min value for tSInt type More...

static tUSInt	getMaxUSInt ()
	get the max value for tUSInt type More...

static tUSInt	getMinUSInt ()
	get the min value for tUSInt type More...

static tInt	getMaxInt ()
	get the max value for tInt type More...

static tInt	getMinInt ()
	get the min value for tInt type More...

static tUInt	getMaxUInt ()
	get the max value for tUInt type More...

static tUInt	getMinUInt ()
	get the min value for tUInt type More...

static tLInt	getMaxLInt ()
	get the max value for tLInt type More...

static tLInt	getMinLInt ()
	get the min value for tLInt type More...

static tULInt	getMaxULInt ()
	get the max value for tULInt type More...

static tULInt	getMinULInt ()
	get the min value for tULInt type More...

static tLLInt	getMaxLLInt ()
	get the max value for tULInt type More...

static tLLInt	getMinLLInt ()
	get the min value for tLLInt type More...

static tULLInt	getMaxULLInt ()
	get the max value for tULLInt type More...

static tULLInt	getMinULLInt ()
	get the min value for tULLInt type More...

static tFloat	getMaxFloat ()
	get the max value for tFloat type More...

static tFloat	getMinFloat ()
	get the min value for tFloat type More...

template<class T >
static T	getEpsilon ()
	get the epsilon value for T type More...

template<class T >
static T	getInfinity ()
	get the infinity for T type More...

static tFloat	getFloatEpsilon ()
	get the epsilon value for tFloat type More...

static tFloat	getFloatInfinity ()
	get the infinity value for tFloat type More...

static tDouble	getMaxDouble ()
	get the max value for tDouble type More...

static tDouble	getMinDouble ()
	get the min value for tDouble type More...

static tDouble	getDoubleInfinity ()
	get the infinity value for tFloat type More...

static tDouble	getDoubleEpsilon ()
	get the epsilon value for tDouble type More...

static tLDouble	getMinLDouble ()
	get the min value for tLDouble type More...

static tLDouble	getMaxLDouble ()
	get the max value for tLDouble type More...

static tLDouble	getLDoubleEpsilon ()
	get the epsilon value for tLDouble type More...

static tDouble	getLDoubleInfinity ()
	get the infinity value for tDouble type More...

static tIndex	getMaxIndex ()
	get the max value for the array/vector indexing type More...

static tIndex	getMinIndex ()
	get the min value for the array/vector indexing type More...

static tUIndex	getMaxUIndex ()
	get the max value for difference the array/vector indexing type More...

static tUIndex	getMinUIndex ()
	get the min value for difference the array/vector indexing type More...

static tFlag	getMaxFlag ()
	get the max value for the tFlag type More...

static tFlag	getMinFlag ()
	get the min value for the tFlag type More...

static tUInteger	getMaxUInteger ()
	get the max value for the unsigned integer type More...

static tUInteger	getMinUInteger ()
	get the min value for the unsigned integer type More...

static tInteger	getMaxInteger ()
	get the max value for the integer type More...

static tInteger	getMinInteger ()
	get the min value for the integer type More...

static tReal	getMaxReal ()
	get the max value for the real type More...

static tReal	getMinReal ()
	get the min value for the real type More...

static tReal	getRealEpsilon ()
	get the eps which is the difference between 1 and the least value greater than 1 that is representable. More...

static tReal	getRealInfinity ()
	get the infinity value More...

template<class T >
static T	computeEpsilon ()
	compute epsilon More...

Static Public Attributes
static const tFlag	CANONICAL_SPACE =0

static const tFlag	SPECTRAL_SPACE =1

Protected Member Functions
	MATH_MultiLevelsToeplitzMatrix (void)
	create a multi level toeplitz matrix More...

virtual	~MATH_MultiLevelsToeplitzMatrix (void)
	destroy a multi level toeplitz matrix More...

tFFTWComplex &	operator[] (const tUIndex &k)
	get the value at index k More...

const tFFTWComplex &	operator[] (const tUIndex &k) const
	get the value at index k More...

void	setSpace (const tFlag &space)
	set the space of the multi level block matrix More...

void	setStorage (SP::MATH_LeafBlockMatrixStorage storage)
	set the storage of the matrix More...

void	setDFT (SP::FFTW_FFT dft)
	set the DFT class More...

const FFTW_FFT &	getDFT () const
	get the FFT class More...

FFTW_FFT &	getDFT ()
	get the FFT class More...

tUIndex	getBlockIndex (const tUIndex &ib, const tUIndex &jb, const tUIndex &N) const
	get the index of the block in the block list More...

virtual void	diagonalize ()=0
	diagonalize the matrix projection of the matrix in the SPECTRAL_SPACE More...

virtual void	recover ()=0
	projection of the matrix in the CANONICAL SPACE More...

void	setThis (SP::CORE_Object p)
	set this weak shared pointer called toDoAfterThis setting method More...

virtual void	toDoAfterThisSetting ()
	method called after setThis() method this method can oly be called once. More...

Private Member Functions
	SP_OBJECT (MATH_MultiLevelsToeplitzMatrix)

tUIndex	getIndex (const tUIndex &i, const tUIndex &j, const tUSInt &level, const tUIndex &nRows, tUIndex &nValues) const
	return the index in values of the matrix of the element at row i and j More...

Private Attributes
tFlag	mSpace

tUIndex	mCanonicalSpaceSize

CORE_UIndexArray	mLevels

tUIndex	mDimension

SP::MATH_LeafBlockMatrixStorage	mStorage

SP::FFTW_FFT	mFFT

Detailed Description

This class is multi levels toeplitz matrix. The matrix at level k is composed by $ 2.n_k-1 $ toeplitz block matrices:

$T = \left[ {\begin{array}{ccccc} T^k_0 & T^k_{-1} & T^k_{-2} & ... & T^k_{1-n_k} \\ T^k_1 & T^k_0 & ... & ... & T^k_{2-n_k} \\ ... & ... & ... & ... & ... \\ T^k_{n_k-1} & T^k_{n_k-2} & ... & ... & T^k_0 \end{array} } \right]$

The blocks at level 0 is a general matrix of size f x f.

The blocks at level k are saved in the list ${T^k_{1-n^k},...,T^k_{-2},T^k_{-1},T^k_0,T^k_1,...,T^k_{n^k-2},T^k_{n^k-1}}$ . Each toeplitz block block $T^k_{i}$ are stored in the same way.

For each level l, The number of Toeplitz blocks per row $ n_k $ is given by the method getLevels()[l] where as the total number of blocks $ 2.n_k-1 $ is given by the method getBlocksNumber().

The total number of blocks is given by the method getBlocksNumber()

The leaf block at level 0 can be stored in two kinds of storage either full or packed. The dimension of a leaf block is given by the method getLeafBlockDimension() whereas the memory size for the storage of a leaf block is given by the method getLeafBlockSize()

The number of rows or columns of the matrix is given by the method getDimension() and its value at row i and column j is given by the operator ()(i,j)

The advantage of the Toeplitz matrix is that the product Matrix . Vector can be computed very fast by Discrete Fourier Transformations. The values of the matrix is computed in 2 spaces: the spectral space in which the matrix is diagonal and the canonical space. The projection on each space is done by DFT . So, the size N of the matrix in the canonical space is given by getCanonicalSpaceSize() and the size P of the matrix in the spectral space is given by getSpectralSpaceSize(). The method getSpace() gives the current space in which the values are expressed.

The Matrix vector product method is vectorProduct(). Before using it, the values of the matrix must be projected in the spectral spectral space by the method projection()

For example: consider the matrix 2x2x2 levels matrix with leaf block matrix of size 1

the values of the matrix is stored as {[(27) (26) (25)] [(24) (23) (22)] [(21) (20) (19) ]} {[(18) (17) (16)] [(15) (14) (13)] [(12) (11) (10) ]} {[(9) (8) (7)] [(6) (5) (4)] [(3) (3) (1) ]} '{' corresponds to level 3, '[' to level 2 '(' to level 1.

The MATH_MultiLevelsFFTToeplitzMatrix deals with the projection on spectral space with a DFT transform.

The are 4 kinds of implemented spectral spaces:

the N-multi levels matrix may be considered as a 1 level matrix of blocks number . For this one level, the matrix can be projected in
- a polynomial space see MATH_GlobalMultiLevelsPolynomialToeplitzMatrix or MATH_ElementaryMultiLevelsPolynomialToeplitzMatrix class
- a circular matrix see MATH_ElementaryMultiLevelsCircularToeplitzMatrix
the N-multi levels matrix is kept on as it is and the matrix is projected in a multi-level circular matrix see MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix

Author
Stephane Despreaux

Version
1.0

Constructor & Destructor Documentation

◆ MATH_MultiLevelsToeplitzMatrix()

MATH_MultiLevelsToeplitzMatrix::MATH_MultiLevelsToeplitzMatrix ( void )

protected

create a multi level toeplitz matrix

References CANONICAL_SPACE, mCanonicalSpaceSize, mDimension, mSpace, mStorage, and MATH_LeafBlockMatrixFullStorage::New().

Here is the call graph for this function:

◆ ~MATH_MultiLevelsToeplitzMatrix()

MATH_MultiLevelsToeplitzMatrix::~MATH_MultiLevelsToeplitzMatrix ( void )

protectedvirtual

destroy a multi level toeplitz matrix

Member Function Documentation

◆ clear()

void MATH_MultiLevelsToeplitzMatrix::clear ( )

virtual

clear the multi level toeplitz matrix

Reimplemented in MATH_MultiLevelsFFTToeplitzMatrix.

References CANONICAL_SPACE, CORE_Array< T >::clear(), mCanonicalSpaceSize, mDimension, mFFT, mLevels, and mSpace.

Referenced by MATH_MultiLevelsFFTToeplitzMatrix::clear(), and operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeEpsilon()

template<class T >

static T CORE_Object::computeEpsilon ( )

inlinestaticinherited

compute epsilon

Returns: the epsilon value eps=10^{-p/3} where p is defined by getEpsilon()=10^{-p}

◆ copy()

void MATH_MultiLevelsToeplitzMatrix::copy ( const MATH_MultiLevelsToeplitzMatrix & mat )

virtual

copy the instance

Reimplemented in MATH_GlobalMultiLevelsPolynomialToeplitzMatrix, MATH_ElementaryMultiLevelsCircularToeplitzMatrix, MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix, MATH_ElementaryMultiLevelsPolynomialToeplitzMatrix, MATH_MultiLevelsFFTToeplitzMatrix, and MATH_ElementaryMultiLevelsToeplitzMatrix.

References CORE_Array< T >::copy(), CORE_Out::ERROR_MSG, getCanonicalSpaceSize(), getDFT(), getDimension(), getLevels(), CORE_Exception::getMessage(), getSpace(), getStorage(), mCanonicalSpaceSize, mDimension, mFFT, mLevels, mSpace, mStorage, MATH_LeafBlockMatrixStorage::NewInstance(), CORE_Object::out(), and CORE_Out::println().

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::copy(), MATH_MultiLevelsFFTToeplitzMatrix::copy(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::copy(), MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), operator()(), and MATH_ToeplitzTest::toeplitzTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diagonalize()

virtual void MATH_MultiLevelsToeplitzMatrix::diagonalize ( )

protectedpure virtual

diagonalize the matrix projection of the matrix in the SPECTRAL_SPACE

Implemented in MATH_MultiLevelsFFTToeplitzMatrix.

Referenced by projection().

Here is the caller graph for this function:

◆ getBlockIndex()

tUIndex MATH_MultiLevelsToeplitzMatrix::getBlockIndex	(	const tUIndex &	ib,
		const tUIndex &	jb,
		const tUIndex &	N
	)		const

inlineprotected

get the index of the block in the block list

Parameters

ib	row index of the block
jb	colum index of the block
N	size of the level the list are $\{ T_{-N+1},...,T_{-1},T_0,T_1,.....T_{N-1} \}$ N=the number of columns (or rows corresponding to the matrix:

$T = \left[ {\begin{array}{ccccc} T_0 & T_{-1} & T_{-1} & ... & T_{1-N} \\ T_1 & T_0 & ... & ... & T_{2-N} \\ ... & ... & ... & ...& ... \\ T_{N-1} & T_{N-2} & ... & ... & T_0 \end{array} } \right]$

Returns: the block index in the blocks list of $T_{ib-jb}$ which is ib-jb+N-1

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::getElementIndex(), and getIndex().

Here is the caller graph for this function:

◆ getBlocksNumber() [1/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getBlocksNumber ( ) const

inline

get the blocks number

Returns: the number of blocks

References getLeafBlockSize().

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralSpace(), MATH_ElementaryMultiLevelsCircularToeplitzMatrix::buildSpectralSpace(), MATH_ElementaryMultiLevelsToeplitzMatrix::recoverCanonicalSpace(), and MATH_ElementaryMultiLevelsCircularToeplitzMatrix::recoverCanonicalSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBlocksNumber() [2/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getBlocksNumber ( const tUIndex & l ) const

inline

get the blocks number at the level

Parameters

l	index of the level

Returns: the number of blocks

◆ getBlocksNumberPerRow()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getBlocksNumberPerRow ( const tUSInt & l ) const

inline

get the blocks number per row or column at the level

Parameters

l	index of the level >=1

Returns: the number of blocks at the level l per row (or column) l=1 is the levels which contains the leaf block levels whise level is 0

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::getElementIndex().

Here is the caller graph for this function:

◆ getCanonicalSpaceSize()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getCanonicalSpaceSize ( ) const

inline

get canonical space size

Returns: the memory size of the canonical space getLeafBlockSize()*getBlocksNumber();

References mCanonicalSpaceSize.

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralSpace(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::buildSpectralSpace(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildSpectralSpace(), copy(), MATH_ElementaryMultiLevelsToeplitzMatrix::recoverCanonicalSpace(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::recoverCanonicalSpace(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::recoverCanonicalSpace(), and MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ getClassName() [1/2]

tString CORE_Object::getClassName ( ) const

inherited

return the class name of the object

Returns: the class name of the object

References tString.

Referenced by CORE_Object::getIdentityString(), EMM_Operator::getName(), and CORE_Object::isMemoryChecked().

Here is the caller graph for this function:

◆ getClassName() [2/2]

static tString CORE_Object::getClassName ( const tString & identityString )

inlinestaticinherited

return the class name of the object

Parameters

identityString the identity string of the object

Returns: the class name

◆ getColumnsNumber()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getColumnsNumber ( ) const

inline

get the dimension of the matrix

Returns: the number of rows or columns of the matrix

References mDimension.

Referenced by toString().

Here is the caller graph for this function:

◆ getDFT() [1/2]

const FFTW_FFT& MATH_MultiLevelsToeplitzMatrix::getDFT ( ) const

inlineprotected

get the FFT class

Returns: the fft class

Here is the caller graph for this function:

◆ getDFT() [2/2]

FFTW_FFT& MATH_MultiLevelsToeplitzMatrix::getDFT ( )

inlineprotected

get the FFT class

Returns: the fft class

◆ getDimension()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getDimension ( ) const

inline

get the dimension of the matrix

Returns: the number of rows or columns of the matrix

References mDimension.

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::buildColumnLeadingDimensions(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::buildColumnLeadingDimensions(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildLeadingDimensions(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildRowLeadingDimensions(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::buildRowLeadingDimensions(), copy(), MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), MATH_ElementaryMultiLevelsToeplitzMatrix::getElementIndex(), and MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ getDoubleEpsilon()

static tDouble CORE_Object::getDoubleEpsilon ( )

inlinestaticinherited

get the epsilon value for tDouble type

Returns: the epsilon value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getDoubleInfinity()

static tDouble CORE_Object::getDoubleInfinity ( )

inlinestaticinherited

get the infinity value for tFloat type

Returns: the intinity value for tFloat type

◆ getEpsilon()

template<class T >

static T CORE_Object::getEpsilon ( )

inlinestaticinherited

get the epsilon value for T type

Returns: the epsilon value for T type

◆ getFloatEpsilon()

static tFloat CORE_Object::getFloatEpsilon ( )

inlinestaticinherited

get the epsilon value for tFloat type

Returns: the epsilon value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getFloatInfinity()

static tFloat CORE_Object::getFloatInfinity ( )

inlinestaticinherited

get the infinity value for tFloat type

Returns: the intinity value for tFloat type

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const

inlineinherited

return the identity string of the object of the form className_at_address

Returns: the identity string of the object

References CORE_Object::getClassName(), CORE_Object::pointer2String(), and tString.

Referenced by MATH_GaussLegendreIntegration::copy(), EMM_MultiScaleGrid::initialize(), CORE_Object::isInstanceOf(), CORE_Object::printObjectsInMemory(), MATH_Matrix::toString(), EMMG_SLPeriodicMultiScale::toString(), EMM_Stepper::toString(), EMM_AnisotropyDirectionsField::toString(), EMM_BlockMassMatrix::toString(), CORE_Object::toString(), EMM_Tensors::toString(), EMM_MultiScaleGrid::toString(), EMM_MatterField::toString(), EMM_Grid3D::toString(), and EMM_LandauLifschitzSystem::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIndex() [1/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getIndex	(	const tUIndex &	i,
		const tUIndex &	j
	)		const

inline

return the index in values of the matrix value at row i and column j

Parameters

i	index of row in [0,getDimension()[
j	index of column in [0,getDimension(){

Returns: the index of the element in the values

References getRowsNumber(), CORE_Array< T >::getSize(), getToeplitzBlockIndex(), tIndex, tUIndex, and tUSInt.

Referenced by MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::buildColumnLeadingDimensions(), MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::buildRowLeadingDimensions(), getIndex(), getToeplitzBlockIndex(), and operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIndex() [2/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getIndex	(	const tUIndex &	i,
		const tUIndex &	j,
		const tUSInt &	level,
		const tUIndex &	nRows,
		tUIndex &	nValues
	)		const

private

return the index in values of the matrix of the element at row i and j

Parameters

i	index of the row
j	index of the colum
level	index of the level in [1,getLevelsNumber()[
nRows	number of rows of the matrix at level
nValues	number of values of the level

References getBlockIndex(), getIndex(), mLevels, mStorage, and tUIndex.

Here is the call graph for this function:

◆ getInfinity()

template<class T >

static T CORE_Object::getInfinity ( )

inlinestaticinherited

get the infinity for T type

Returns: the infinity value for T type

◆ getLDoubleEpsilon()

static tLDouble CORE_Object::getLDoubleEpsilon ( )

inlinestaticinherited

get the epsilon value for tLDouble type

Returns: the epsilon value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getLDoubleInfinity()

static tDouble CORE_Object::getLDoubleInfinity ( )

inlinestaticinherited

get the infinity value for tDouble type

Returns: the infinity value for tDouble type

◆ getLeafBlockDimension()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getLeafBlockDimension ( ) const

inline

return the dimension of the leaf block matrix

Returns: the number of rows or columns of the leaf block matrix

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::buildColumnLeadingDimensions(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildLeadingDimensions(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildRowLeadingDimensions(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), MATH_ElementaryMultiLevelsToeplitzMatrix::getElementIndex(), and setLevels().

Here is the caller graph for this function:

◆ getLeafBlockSize()

tUIndex MATH_MultiLevelsToeplitzMatrix::getLeafBlockSize ( ) const

inline

return the size of the leaf block matrix

Returns: the memory size of the leaf block matrix

Referenced by getBlocksNumber(), and setLevels().

Here is the caller graph for this function:

◆ getLeafBlockValues() [1/2]

const tFFTWComplex* MATH_MultiLevelsToeplitzMatrix::getLeafBlockValues ( const tIndex indices[] ) const

inline

get the values of the leaf block

Parameters

indices indices of the block

Returns: a pointer to the values of size getLeafBlockSize()

References CORE_Array< T >::getSize(), getToeplitzBlockIndex(), and getValues().

Referenced by MATH_ToeplitzTest::toeplitzTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLeafBlockValues() [2/2]

tFFTWComplex* MATH_MultiLevelsToeplitzMatrix::getLeafBlockValues ( const tIndex indices[] )

inline

get the values of the leaf block

Parameters

indices indices of the block

Returns: a pointer to the values of size getLeafBlockSize()

References CORE_Array< T >::getSize(), getToeplitzBlockIndex(), and getValues().

Here is the call graph for this function:

◆ getLevels()

const CORE_UIndexArray& MATH_MultiLevelsToeplitzMatrix::getLevels ( ) const

inline

get the level of the matrix

Returns: the levels array

References mLevels.

Referenced by MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildLeadingDimensions(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildSpectralSpace(), MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::computeSpectralSpaceSizePerDimension(), copy(), and MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::recoverCanonicalSpace().

Here is the caller graph for this function:

◆ getLevelsNumber()

tUSInt MATH_MultiLevelsToeplitzMatrix::getLevelsNumber ( ) const

inline

get the number of levels of the matrix

References CORE_Array< T >::getSize().

Referenced by MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildSpectralSpace(), MATH_ElementaryMultiLevelsToeplitzMatrix::getElementIndex(), and MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::recoverCanonicalSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxChar()

static tChar CORE_Object::getMaxChar ( )

inlinestaticinherited

get the max value for tChar type

Returns: the max value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxDouble()

static tDouble CORE_Object::getMaxDouble ( )

inlinestaticinherited

get the max value for tDouble type

Returns: the max value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFlag()

static tFlag CORE_Object::getMaxFlag ( )

inlinestaticinherited

get the max value for the tFlag type

Returns: the max value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFloat()

static tFloat CORE_Object::getMaxFloat ( )

inlinestaticinherited

get the max value for tFloat type

Returns: the max value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxIndex()

static tIndex CORE_Object::getMaxIndex ( )

inlinestaticinherited

get the max value for the array/vector indexing type

Returns: the max value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInt()

static tInt CORE_Object::getMaxInt ( )

inlinestaticinherited

get the max value for tInt type

Returns: the max value for tInt type

Referenced by MATSGN_FFT::fastFourierTransform3D_FFTW(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInteger()

static tInteger CORE_Object::getMaxInteger ( )

inlinestaticinherited

get the max value for the integer type

Returns: the max value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLDouble()

static tLDouble CORE_Object::getMaxLDouble ( )

inlinestaticinherited

get the max value for tLDouble type

Returns: the max value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLInt()

static tLInt CORE_Object::getMaxLInt ( )

inlinestaticinherited

get the max value for tLInt type

Returns: the max value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLLInt()

static tLLInt CORE_Object::getMaxLLInt ( )

inlinestaticinherited

get the max value for tULInt type

Returns: the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxReal()

static tReal CORE_Object::getMaxReal ( )

inlinestaticinherited

get the max value for the real type

Returns: he max value for the real type

Referenced by EMM_MatterField::adimensionize(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxSInt()

static tSInt CORE_Object::getMaxSInt ( )

inlinestaticinherited

get the max value for tSInt type

Returns: the max value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUChar()

static tUChar CORE_Object::getMaxUChar ( )

inlinestaticinherited

get the max value for tUChar type

Returns: the max value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUIndex()

static tUIndex CORE_Object::getMaxUIndex ( )

inlinestaticinherited

get the max value for difference the array/vector indexing type

Returns: the max value for difference the array/vector indexing type

Referenced by CORE_Vector< T >::addAfterIndices(), CORE_Vector< T >::search(), CORE_Test::testType(), CORE_Integer::toHexString(), and CORE_Integer::toString().

Here is the caller graph for this function:

◆ getMaxUInt()

static tUInt CORE_Object::getMaxUInt ( )

inlinestaticinherited

get the max value for tUInt type

Returns: the max value for tUInt type

Referenced by EMM_Array< tCellFlag >::loadFromFile(), EMM_RealField::loadFromFile(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUInteger()

static tUInteger CORE_Object::getMaxUInteger ( )

inlinestaticinherited

get the max value for the unsigned integer type

Returns: the max value for the unsigned integer type

Referenced by MATH_Pn::computeExtrenums(), EMM_MultiScaleGrid::computeLevelsNumber(), EMM_Input::restoreBackup(), MATH_P0::solve(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULInt()

static tULInt CORE_Object::getMaxULInt ( )

inlinestaticinherited

get the max value for tULInt type

Returns: the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULLInt()

static tULLInt CORE_Object::getMaxULLInt ( )

inlinestaticinherited

get the max value for tULLInt type

Returns: the max value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUSInt()

static tUSInt CORE_Object::getMaxUSInt ( )

inlinestaticinherited

get the max value for tUSInt type

Returns: the max value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMemorySize()

virtual tULLInt MATH_MultiLevelsToeplitzMatrix::getMemorySize ( ) const

inlinevirtual

return the memory size in byte

Returns: the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented in MATH_MultiLevelsFFTToeplitzMatrix, and MATH_ElementaryMultiLevelsToeplitzMatrix.

References null.

Referenced by MATH_MultiLevelsFFTToeplitzMatrix::getMemorySize().

Here is the caller graph for this function:

◆ getMinChar()

static tChar CORE_Object::getMinChar ( )

inlinestaticinherited

get the min value for tChar type

Returns: the min value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinDouble()

static tDouble CORE_Object::getMinDouble ( )

inlinestaticinherited

get the min value for tDouble type

Returns: the min value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFlag()

static tFlag CORE_Object::getMinFlag ( )

inlinestaticinherited

get the min value for the tFlag type

Returns: the min value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFloat()

static tFloat CORE_Object::getMinFloat ( )

inlinestaticinherited

get the min value for tFloat type

Returns: the min value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinIndex()

static tIndex CORE_Object::getMinIndex ( )

inlinestaticinherited

get the min value for the array/vector indexing type

Returns: the min value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInt()

static tInt CORE_Object::getMinInt ( )

inlinestaticinherited

get the min value for tInt type

Returns: the min value for tInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInteger()

static tInteger CORE_Object::getMinInteger ( )

inlinestaticinherited

get the min value for the integer type

Returns: the minin value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLDouble()

static tLDouble CORE_Object::getMinLDouble ( )

inlinestaticinherited

get the min value for tLDouble type

Returns: the min value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLInt()

static tLInt CORE_Object::getMinLInt ( )

inlinestaticinherited

get the min value for tLInt type

Returns: the min value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLLInt()

static tLLInt CORE_Object::getMinLLInt ( )

inlinestaticinherited

get the min value for tLLInt type

Returns: the min value for tLLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinReal()

static tReal CORE_Object::getMinReal ( )

inlinestaticinherited

get the min value for the real type

Returns: the min value for the real type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinSInt()

static tSInt CORE_Object::getMinSInt ( )

inlinestaticinherited

get the min value for tSInt type

Returns: the min value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUChar()

static tUChar CORE_Object::getMinUChar ( )

inlinestaticinherited

get the min value for tUChar type

Returns: the min value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUIndex()

static tUIndex CORE_Object::getMinUIndex ( )

inlinestaticinherited

get the min value for difference the array/vector indexing type

Returns: the min value for difference the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInt()

static tUInt CORE_Object::getMinUInt ( )

inlinestaticinherited

get the min value for tUInt type

Returns: the min value for tUInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInteger()

static tUInteger CORE_Object::getMinUInteger ( )

inlinestaticinherited

get the min value for the unsigned integer type

Returns: the min value for the unsigned integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULInt()

static tULInt CORE_Object::getMinULInt ( )

inlinestaticinherited

get the min value for tULInt type

Returns: the min value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULLInt()

static tULLInt CORE_Object::getMinULLInt ( )

inlinestaticinherited

get the min value for tULLInt type

Returns: the min value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUSInt()

static tUSInt CORE_Object::getMinUSInt ( )

inlinestaticinherited

get the min value for tUSInt type

Returns: the min value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getOut()

static SP::CORE_Out CORE_Object::getOut ( )

inlinestaticinherited

get the output

Returns: the shared pointer to the output stream

References CORE_Object::OUT.

◆ getPointerAddress()

tString CORE_Object::getPointerAddress ( ) const

inlineinherited

return the identity string of the object

Returns: the identity string of the object

References CORE_Object::pointer2String().

Here is the call graph for this function:

◆ getRealEpsilon()

static tReal CORE_Object::getRealEpsilon ( )

inlinestaticinherited

get the eps which is the difference between 1 and the least value greater than 1 that is representable.

Returns: the eps which is the difference between 1 and the least value greater than 1 that is representable.

Referenced by MATH_P4::solveP4De(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getRealInfinity()

static tReal CORE_Object::getRealInfinity ( )

inlinestaticinherited

get the infinity value

Returns: the inifinity value for the real type

Referenced by BrentFunction::BrentFunction(), EMM_OperatorsTest::compareDiscretizedData(), EMM_IterativeTimeStep::EMM_IterativeTimeStep(), EMM_SLElementaryDemagnetizedMatrix::Kxy(), NRFunction::NRFunction(), EMM_PolynomialInterpolationTimeStep::optimizeTimeFunction(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getRealValue()

tReal MATH_MultiLevelsToeplitzMatrix::getRealValue	(	const tUIndex &	i,
		const tUIndex &	j
	)		const

inline

get the real value at row i and column j

Returns: the real part of the complex at row i and rows j

Referenced by toString().

Here is the caller graph for this function:

◆ getRowsNumber()

const tUIndex& MATH_MultiLevelsToeplitzMatrix::getRowsNumber ( ) const

inline

get the dimension of the matrix

Returns: the number of rows or columns of the matrix

References mDimension.

Referenced by getIndex(), MATH_ToeplitzTest::toeplitzTest(), and toString().

Here is the caller graph for this function:

◆ getSharedPointer() [1/2]

void CORE_Object::getSharedPointer ( SP::CORE_Object & p )

inlineinherited

get the shared pointer of this class into p

Parameters

p	: shared pointer of the class This

Referenced by CORE_Map< Key, Value >::getSharedPointer(), CORE_ArrayList< tString >::getSharedPointer(), EMM_Array< tCellFlag >::getSharedPointer(), CORE_Array< tCellFlag >::getSharedPointer(), CORE_MorseArray< tUChar >::getSharedPointer(), CORE_Vector< T >::getSharedPointer(), and CORE_Object::printObjectsInMemory().

Here is the caller graph for this function:

◆ getSharedPointer() [2/2]

void CORE_Object::getSharedPointer ( SPC::CORE_Object & p ) const

inlineinherited

get the shared pointer of this class into p

Parameters

p	: shared pointer of the class This

◆ getSpace()

const tFlag& MATH_MultiLevelsToeplitzMatrix::getSpace ( ) const

inline

get the space of the matrix

Returns

the space of the matrix in :

CANONICAL_SPACE
SPECTRAL_SPACE

References mSpace.

Referenced by copy(), projection(), and MATH_MultiLevelsFFTToeplitzMatrix::vectorProduct().

Here is the caller graph for this function:

◆ getStorage() [1/2]

const MATH_LeafBlockMatrixStorage& MATH_MultiLevelsToeplitzMatrix::getStorage ( ) const

inline

get the storage of the leaf matrices

Returns: the storage of the leaf block matrix

Here is the caller graph for this function:

◆ getStorage() [2/2]

MATH_LeafBlockMatrixStorage& MATH_MultiLevelsToeplitzMatrix::getStorage ( )

inline

get the storage of the leaf matrices

Returns: the storage of the leaf block matrix

◆ getThread()

static CORE_Thread& CORE_Object::getThread ( )

inlinestaticinherited

get the profilier

Returns: the profiler

Here is the caller graph for this function:

◆ getToeplitzBlockIndex() [1/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getToeplitzBlockIndex	(	const tUSInt &	nLevels,
		const tUIndex	N[],
		const tIndex	I[]
	)		const

get the block index corresponding to indices

Parameters

nLevels	number of levels
N	: number of element by level of size nLevels
I	index of element at each level i[l] in ]-N[l],N[l][

Returns: the index of element as follow: index = (i_0+N_0-1+(2*N_0-1)*(i_1+N_1-1+(2*N_1-1)*(i_2+N_2-1+...)))

References tIndex, tUIndex, and tUSInt.

Referenced by MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::buildSpectralSpace(), getIndex(), getLeafBlockValues(), getToeplitzBlockIndex(), and MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ getToeplitzBlockIndex() [2/2]

tUIndex MATH_MultiLevelsToeplitzMatrix::getToeplitzBlockIndex ( const tIndex I[] ) const

inline

get the block index corresponding to indices

Parameters

I	index of element at each level i[l] in ]-N[l],N[l][

Returns: the index of element as follow: index = (i_0+N_0-1+(2*N_0-1)*(i_1+N_1-1+(2*N_1-1)*(i_2+N_2-1+...)))

References getIndex(), CORE_Array< T >::getSize(), getToeplitzBlockIndex(), tUIndex, and tUSInt.

Here is the call graph for this function:

◆ getTypeName()

template<class T >

static tString CORE_Object::getTypeName ( )

inlinestaticinherited

get type name

Returns: the type name of the class

References tString.

◆ getValues() [1/2]

FFTW_ComplexArray& MATH_MultiLevelsToeplitzMatrix::getValues ( )

inline

get the values of the matrix

Returns: the values array

Referenced by MATH_ToeplitzTest::emicromTest(), getLeafBlockValues(), and MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ getValues() [2/2]

const FFTW_ComplexArray& MATH_MultiLevelsToeplitzMatrix::getValues ( ) const

inline

get the values of the matrix

Returns: the values array

◆ is32Architecture()

static tBoolean CORE_Object::is32Architecture ( )

inlinestaticinherited

return true if the machine is a 32 bits machine

Returns: true is the computing is done in a 32 bits machine

References CORE_Object::pointer2String(), CORE_Object::printObjectsInMemory(), and tString.

Referenced by CORE_Test::testType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is64Architecture()

static tBoolean CORE_Object::is64Architecture ( )

inlinestaticinherited

return true if the machine is a 64 bits machine

Returns: true is the computing is done in a 64 bits machine

Referenced by EMM_VTK::getVTKType(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ isInstanceOf() [1/2]

template<class T >

tBoolean CORE_Object::isInstanceOf ( ) const

inlineinherited

test if the clas T is an instance of this class

Returns: true if the object is an instance of T

References null.

Referenced by MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ isInstanceOf() [2/2]

tBoolean CORE_Object::isInstanceOf ( const tString & name ) const

inlineinherited

test if the object is an instance of className

Parameters

name	name of the class

Returns: true if the object is an instance of class Name

References CORE_Object::getIdentityString().

Here is the call graph for this function:

◆ isMemoryChecked()

static const tBoolean& CORE_Object::isMemoryChecked ( )

inlinestaticinherited

get if the memory checking is used

Returns: true: if the memory checking is used.

References CORE_Object::getClassName(), CORE_Object::mIsMemoryTesting, and tString.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NewInstance()

virtual SP::MATH_MultiLevelsToeplitzMatrix MATH_MultiLevelsToeplitzMatrix::NewInstance ( ) const

pure virtual

new instance

Returns: a New instance of this

Implemented in MATH_GlobalMultiLevelsPolynomialToeplitzMatrix, MATH_ElementaryMultiLevelsCircularToeplitzMatrix, MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix, and MATH_ElementaryMultiLevelsPolynomialToeplitzMatrix.

Referenced by MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), MATH_ElementaryMultiLevelsToeplitzMatrix::MATH_ElementaryMultiLevelsToeplitzMatrix(), and MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ operator()() [1/2]

const tFFTWComplex& MATH_MultiLevelsToeplitzMatrix::operator()	(	const tUIndex &	i,
		const tUIndex &	j
	)		const

inline

get the value of the matrix at row i and column j

Parameters

i	the index of the row [0,getDimension()[
j	the index of the column in [0,getDimension()[ return the value at element (i,j)

References getIndex().

Here is the call graph for this function:

◆ operator()() [2/2]

tFFTWComplex& MATH_MultiLevelsToeplitzMatrix::operator()	(	const tUIndex &	i,
		const tUIndex &	j
	)

inline

get the value of the matrix at row i and column j

Parameters

i	the index of the row [0,getDimension()[
j	the index of the column in [0,getDimension()[ return the value at element (i,j)

References clear(), copy(), and getIndex().

Here is the call graph for this function:

◆ operator[]() [1/2]

tFFTWComplex& MATH_MultiLevelsToeplitzMatrix::operator[] ( const tUIndex & k )

inlineprotected

get the value at index k

Parameters

k	index of the value in [0,getSpectralSpaceDimension()[ return the value at index k

◆ operator[]() [2/2]

const tFFTWComplex& MATH_MultiLevelsToeplitzMatrix::operator[] ( const tUIndex & k ) const

inlineprotected

get the value at index k

Parameters

k	index of the value in [0,etSpectralSpaceDimension()()[ return the value at index k

◆ out()

static CORE_Out& CORE_Object::out ( )

inlinestaticinherited

get the output

Returns: the output stream

Referenced by EMM_Matter::adimensionize(), EMM_DisplacementFVMOperator::backup(), EMM_DisplacementOperator::backup(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), EMM_Test::caseTest(), EMM_Test::caseTests(), EMM_MatterField::computeAnisotropyDirectionsField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), copy(), CORE_Exception::CORE_Exception(), EMM_MatterField::createAnisotropyOperator(), CORE_Run::createIO(), EMM_ElementaryTest::defaultBackupTest(), EMM_ElementaryTest::defaultTest(), MATH_MultiLevelsFFTToeplitzMatrix::diagonalize(), EMM_DisplacementFVMOperator::discretize(), EMM_MagnetostrictionOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_TensorsTest::doubleDotCrossDoubleDotScalarTests(), EMM_4Tensors::doubleDotCrossProduct(), EMM_TensorsTest::doubleDotCrossProductTests(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_TensorsTest::doubleDotCrossSquaredScalarTests(), EMM_4Tensors::doubleDotProduct(), EMM_TensorsTest::doubleDotProductTests(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_Test::elementaryTests(), FFTW_Test::fftwTutorial(), MATH_IntegrationTest::gaussLegendreTest(), EMM_MagnetostrictionTest::HComputingTest(), EMM_DemagnetizedPeriodicalTest::HTest(), EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMM_TensorsTest::initializationTests(), EMM_MultiScaleGrid::initialize(), EMM_MultiScaleSDGrid::initialize(), EMM_MatterField::loadFromANIFile(), EMM_AnisotropyDirectionsField::loadFromFile(), EMM_Matter::loadFromFile(), EMM_Grid3D::loadFromGEOFile(), EMM_MatterField::loadFromLOCFile(), EMM_Array< tCellFlag >::loadFromStream(), EMM_Matter::loadFromStream(), EMM_Matter::loadMattersFromFile(), EMM_Run::loadSystemFromOptions(), EMM_ElementaryTest::magnetostrictionBackupTest(), CORE_Run::make(), EMMH_Run::makeHysteresis(), EMM_Run::makeRun(), CORE_Run::makeType(), EMM_ElementaryTest::optionsTest(), MATH_PolynomialTest::P4Tests(), EMM_Test::primaryTests(), EMM_LandauLifschitzSystem::printLog(), CORE_Run::printOptions(), EMM_2PackedSymmetricTensors::product(), EMMG_SLDemagnetizedOperator::projectionOnSpectralSpace(), CORE_Run::readOptionsFromCommandLine(), CORE_Test::readVectorTest(), EMM_DemagnetizedPeriodicalTest::relaxationTest(), EMM_DisplacementFVMOperator::restore(), EMM_DisplacementOperator::restore(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), EMM_AnisotropyDirectionsField::saveToFile(), EMM_MatterField::saveToFile(), EMM_Grid3D::saveToGEOFile(), CORE_IOTest::searchTest(), EMMH_Hysteresis::setInitialMagnetizationField(), setLevels(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_TensorsTest::squaredDoubleDotCrossScalarTests(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_TensorsTest::squaredDoubleDotScalarTests(), EMM_TensorsTest::squaredDoubleDotTests(), EMM_MatterTest::testAdimensionize(), EMM_MatterTest::testANIFile(), CORE_Test::testComplex(), CORE_Test::testDateWeek(), FFTW_Test::testDFT(), EMM_MatterTest::testIO(), EMM_ODETest::testODE(), CORE_Test::testOut(), CORE_Test::testReal(), EMM_FieldTest::testRealArray(), EMM_Grid3DTest::testSegment(), EMM_Grid3DTest::testThinSheet(), CORE_Test::testTime(), CORE_Test::testType(), MATH_FullMatrix::toString(), EMM_DemagnetizedPeriodicalTest::xyPeriodicalCubeSDGTest(), and EMM_DemagnetizedPeriodicalTest::xyPeriodicalSheetSDGTest().

Here is the caller graph for this function:

◆ pointer2String()

tString CORE_Object::pointer2String ( const void * obj )

staticinherited

return the string representation of a pointer

Parameters

obj	: oject to get the string pointer

Returns: the string pointer of the object

References tString.

Referenced by CORE_Object::CORE_Object(), CORE_Object::getIdentityString(), CORE_Object::getPointerAddress(), CORE_Object::is32Architecture(), and CORE_Object::~CORE_Object().

Here is the caller graph for this function:

◆ printObjectsInMemory() [1/2]

void CORE_Object::printObjectsInMemory ( ostream & f )

staticinherited

print object in memory

Parameters

f	: output to print the objects in memory

References CORE_Object::getIdentityString(), CORE_Object::getSharedPointer(), CORE_Object::mIsMemoryTesting, CORE_Object::mObjects, and tInteger.

Here is the call graph for this function:

◆ printObjectsInMemory() [2/2]

static void CORE_Object::printObjectsInMemory ( )

inlinestaticinherited

print object in memory in the standart output

Referenced by CORE_Object::is32Architecture(), and main().

Here is the caller graph for this function:

◆ projection()

void MATH_MultiLevelsToeplitzMatrix::projection ( const tFlag & space )

inline

make the projection in the space

Parameters

space

space of projection

SPECTRAL_SPACE: for diagonalization of the matrix
CANONICAL_SPACE: for the canonical space

References CANONICAL_SPACE, diagonalize(), getSpace(), recover(), setSpace(), and SPECTRAL_SPACE.

Referenced by MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), and MATH_ToeplitzTest::toeplitzTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recover()

virtual void MATH_MultiLevelsToeplitzMatrix::recover ( )

protectedpure virtual

projection of the matrix in the CANONICAL SPACE

Implemented in MATH_MultiLevelsFFTToeplitzMatrix.

Referenced by projection().

Here is the caller graph for this function:

◆ resetOut()

static void CORE_Object::resetOut ( )

inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ resetThread()

static void CORE_Object::resetThread ( )

inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ setDFT()

void MATH_MultiLevelsToeplitzMatrix::setDFT ( SP::FFTW_FFT dft )

inlineprotected

set the DFT class

Parameters

dft	Discrete Fourier Transform class to set

References null.

Referenced by MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix::MATH_ElementaryMultiLevelsCircularTensorToeplitzMatrix(), MATH_ElementaryMultiLevelsToeplitzMatrix::MATH_ElementaryMultiLevelsToeplitzMatrix(), and MATH_GlobalMultiLevelsPolynomialToeplitzMatrix::MATH_GlobalMultiLevelsPolynomialToeplitzMatrix().

Here is the caller graph for this function:

◆ setIsMemoryChecked()

static void CORE_Object::setIsMemoryChecked ( const tBoolean & v )

inlinestaticinherited

set if the memory checking is used

Parameters

v	: true to check memory

Referenced by main().

Here is the caller graph for this function:

◆ setLeafBlockDimension()

virtual void MATH_MultiLevelsToeplitzMatrix::setLeafBlockDimension ( const tUIndex & n )

inlinevirtual

set the dimension of leaf block

Parameters

n	number of rows or columns of the leaf square matrix

Referenced by setLevels().

Here is the caller graph for this function:

◆ setLevels() [1/2]

virtual void MATH_MultiLevelsToeplitzMatrix::setLevels	(	const tUSInt &	levelsNumber,
		const tUIndex	levels[],
		const tUIndex &	nD
	)

inlinevirtual

set the levels of the matrix

Parameters

levelsNumber	the number of levels
levels	levels[k] is the number of Toeplitz matrices at each row which composed the level k in [0,levelsNumber[
nD	dimension of the block matrix (1D,2D,3D,..nD)

The level 0 contains the leaf matrices

The level levelsNumber contains the last level.

References setLeafBlockDimension(), tUIndex, and tUSInt.

Referenced by MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), and MATH_ToeplitzTest::toeplitzTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLevels() [2/2]

void MATH_MultiLevelsToeplitzMatrix::setLevels	(	const tUSInt &	levelsNumber,
		const tUIndex	levels[]
	)

set the levels of the matrix

Parameters

levelsNumber	the number of levels
levels	levels[k] is the number of Toeplitz matrices at each row which composed the level k in [0,levelsNumber[

The Level 0 contains the leaf matrices

The level levelsNumber contains the last level.

Builds the structure of the matrix

the number of toeplitz matrices at each level
the canonical space size
the dimension of the matrix (number of columns or rows)
initialize the space to CANONICAL_SPACE

References CORE_Out::ERROR_MSG, getLeafBlockDimension(), getLeafBlockSize(), CORE_Exception::getMessage(), mCanonicalSpaceSize, mDimension, mFFT, mLevels, CORE_Object::out(), CORE_Out::println(), CORE_Array< T >::setSize(), tUIndex, and tUSInt.

Here is the call graph for this function:

◆ setOut()

static void CORE_Object::setOut ( SP::CORE_Out out )

inlinestaticinherited

set the output stream

Parameters

out	: the shared pointer to the new output stream

References null.

◆ setSpace()

void MATH_MultiLevelsToeplitzMatrix::setSpace ( const tFlag & space )

inlineprotected

set the space of the multi level block matrix

Parameters

space

the space of the matrix:

CANONICAL_SPACE: the space of rows and column
SPECTRAL_SPACE: the spectral space i which the matrix is diagonalized

Referenced by projection().

Here is the caller graph for this function:

◆ setStorage()

void MATH_MultiLevelsToeplitzMatrix::setStorage ( SP::MATH_LeafBlockMatrixStorage storage )

inlineprotected

set the storage of the matrix

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::setStorage().

Here is the caller graph for this function:

◆ setThis()

void CORE_Object::setThis ( SP::CORE_Object p )

inlineprotectedinherited

set this weak shared pointer called toDoAfterThis setting method

Parameters

p	: shared pointer of the class This

References CORE_Object::toDoAfterThisSetting().

Here is the call graph for this function:

◆ setThread()

static void CORE_Object::setThread ( SP::CORE_Thread thread )

inlinestaticinherited

set the thread

Parameters

thread the shared pointer to the thread

References null.

Referenced by EMM_Run::EMM_Run(), EMM_TensorsRun::EMM_TensorsRun(), and MATH_SolverRun::MATH_SolverRun().

Here is the caller graph for this function:

◆ SP_OBJECT()

MATH_MultiLevelsToeplitzMatrix::SP_OBJECT ( MATH_MultiLevelsToeplitzMatrix )

private

◆ toDoAfterThisSetting()

virtual void CORE_Object::toDoAfterThisSetting ( )

inlineprotectedvirtualinherited

method called after setThis() method this method can oly be called once.

Reimplemented in EMM_DisplacementOperator, EMM_DisplacementFVMOperator, EMM_GaussLegendreRelaxation, EMM_GradGaussLegendreRelaxation, and EMM_Object.

Referenced by CORE_Object::setThis().

Here is the caller graph for this function:

◆ toString()

tString MATH_MultiLevelsToeplitzMatrix::toString ( ) const

virtual

return string

Reimplemented from CORE_Object.

References getColumnsNumber(), getRealValue(), getRowsNumber(), FFTW_ComplexArray::getSize(), mFFT, null, CORE_Real::toString(), CORE_Integer::toString(), tString, and tUIndex.

Referenced by vectorProduct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vectorProduct() [1/2]

virtual void MATH_MultiLevelsToeplitzMatrix::vectorProduct	(	const CORE_RealArray &	X,
		CORE_RealArray &	Y
	)		const

inlinevirtual

do the vector product of the circular matrix C with Y by an FFT method

Parameters

X	the vector value
Y	the result

The Toeplitz matrix must be diagonalized before.

computes T.X=Y

Reimplemented in MATH_MultiLevelsFFTToeplitzMatrix.

References CORE_Array< T >::getSize(), CORE_Array< T >::setSize(), toString(), tReal, tString, and tUIndex.

Referenced by EMM_MultiScaleCDGrid::computeDemagnetizedExcitationFieldFromLevel(), EMMG_SLSDXPeriodicMultiScale::computeLevelDemagnetizedField(), EMMG_SLRPPeriodicMultiScale::computeMultiGridExcitationField(), EMM_MultiScaleGrid::computeMultiGridExcitationField(), EMM_MultiScaleSDGrid::computeZonalCenteredDemagnetizedFieldFromLevel(), EMM_MultiScaleSDGrid::computeZonalDemagnetizedFieldAndNextLevelMagnetizationField(), MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), MATH_ToeplitzTest::toeplitzTest(), and MATH_MultiLevelsFFTToeplitzMatrix::vectorProduct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vectorProduct() [2/2]

virtual void MATH_MultiLevelsToeplitzMatrix::vectorProduct	(	const tUIndex &	N,
		const tReal *	X,
		tReal *	Y
	)		const

pure virtual

do the vector product of the circular matrix C with Y by an FFT method

Parameters

N;	the size of X & Y
X	the vector value
Y	the result

The Toeplitz matrix must be diagonalized before.

computes T.X=Y

Implemented in MATH_MultiLevelsFFTToeplitzMatrix.

Member Data Documentation

◆ CANONICAL_SPACE

const tFlag MATH_MultiLevelsToeplitzMatrix::CANONICAL_SPACE =0

static

Referenced by clear(), MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), MATH_MultiLevelsToeplitzMatrix(), projection(), and MATH_ToeplitzTest::toeplitzTest().

◆ mCanonicalSpaceSize

tUIndex MATH_MultiLevelsToeplitzMatrix::mCanonicalSpaceSize

private

Referenced by clear(), copy(), getCanonicalSpaceSize(), MATH_MultiLevelsToeplitzMatrix(), and setLevels().

◆ mDimension

tUIndex MATH_MultiLevelsToeplitzMatrix::mDimension

private

Referenced by clear(), copy(), getColumnsNumber(), getDimension(), getRowsNumber(), MATH_MultiLevelsToeplitzMatrix(), and setLevels().

◆ mFFT

SP::FFTW_FFT MATH_MultiLevelsToeplitzMatrix::mFFT

private

Referenced by clear(), copy(), setLevels(), and toString().

◆ mLevels

CORE_UIndexArray MATH_MultiLevelsToeplitzMatrix::mLevels

private

Referenced by clear(), copy(), getIndex(), getLevels(), and setLevels().

◆ mSpace

tFlag MATH_MultiLevelsToeplitzMatrix::mSpace

private

Referenced by clear(), copy(), getSpace(), and MATH_MultiLevelsToeplitzMatrix().

◆ mStorage

SP::MATH_LeafBlockMatrixStorage MATH_MultiLevelsToeplitzMatrix::mStorage

private

Referenced by copy(), getIndex(), and MATH_MultiLevelsToeplitzMatrix().

◆ SPECTRAL_SPACE

const tFlag MATH_MultiLevelsToeplitzMatrix::SPECTRAL_SPACE =1

static

Referenced by MATH_ToeplitzTest::emicrom411ncTest(), MATH_ToeplitzTest::emicrom411Test(), MATH_ToeplitzTest::emicrom441Test(), MATH_ToeplitzTest::emicrom444Test(), MATH_ToeplitzTest::emicromTest(), projection(), MATH_ToeplitzTest::toeplitzTest(), and MATH_MultiLevelsFFTToeplitzMatrix::vectorProduct().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MATH_MultiLevelsToeplitzMatrix()

◆ ~MATH_MultiLevelsToeplitzMatrix()

Member Function Documentation

◆ clear()

◆ computeEpsilon()

◆ copy()

◆ diagonalize()

◆ getBlockIndex()

◆ getBlocksNumber() [1/2]

◆ getBlocksNumber() [2/2]

◆ getBlocksNumberPerRow()

◆ getCanonicalSpaceSize()

◆ getClassName() [1/2]

◆ getClassName() [2/2]

◆ getColumnsNumber()

◆ getDFT() [1/2]

◆ getDFT() [2/2]

◆ getDimension()

◆ getDoubleEpsilon()

◆ getDoubleInfinity()

◆ getEpsilon()

◆ getFloatEpsilon()

◆ getFloatInfinity()

◆ getIdentityString()

◆ getIndex() [1/2]

◆ getIndex() [2/2]

◆ getInfinity()

◆ getLDoubleEpsilon()

◆ getLDoubleInfinity()

◆ getLeafBlockDimension()

◆ getLeafBlockSize()

◆ getLeafBlockValues() [1/2]

◆ getLeafBlockValues() [2/2]

◆ getLevels()

◆ getLevelsNumber()

◆ getMaxChar()

◆ getMaxDouble()

◆ getMaxFlag()

◆ getMaxFloat()

◆ getMaxIndex()

◆ getMaxInt()

◆ getMaxInteger()

◆ getMaxLDouble()

◆ getMaxLInt()

◆ getMaxLLInt()

◆ getMaxReal()

◆ getMaxSInt()

◆ getMaxUChar()

◆ getMaxUIndex()

◆ getMaxUInt()

◆ getMaxUInteger()

◆ getMaxULInt()

◆ getMaxULLInt()

◆ getMaxUSInt()

◆ getMemorySize()

◆ getMinChar()

◆ getMinDouble()

◆ getMinFlag()

◆ getMinFloat()

◆ getMinIndex()

◆ getMinInt()

◆ getMinInteger()

◆ getMinLDouble()

◆ getMinLInt()

◆ getMinLLInt()

◆ getMinReal()

◆ getMinSInt()

◆ getMinUChar()

◆ getMinUIndex()

◆ getMinUInt()

◆ getMinUInteger()

◆ getMinULInt()