Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::MultiIndex< dim > Class Template Reference
Inheritance diagram for concepts::MultiIndex< dim >:
concepts::StiffArray< dim, uint > concepts::OutputOperator

Public Member Functions

 MultiIndex ()
 Constructor.
 
 MultiIndex (const uint &dft)
 
 MultiIndex (const uint dft[])
 
 MultiIndex (const MultiIndex< dim > &a)
 Copy constructor.
 
bool operator== (const MultiIndex< dim > &a) const
 Comparison operator.
 
bool operator!= (const MultiIndex< dim > &a) const
 Comparison operator.
 
uint length ()
 
void zeros ()
 Fills the memory with zeros.
 
 operator uint * ()
 Returns a pointer to the data in the array.
 
 operator const uint * () const
 Returns a pointer to the data in the array.
 
uintdata ()
 Returns a pointer to the data in the array.
 
const uintdata () const
 Returns a pointer to the data in the array.
 
 operator Array< uint > () const
 
Array< uintarray_data () const
 
const uintoperator[] (const int i) const
 Index operator.
 
uintoperator[] (const int i)
 Index operator.
 
StiffArray< dim, uint > & operator*= (const uint n)
 Scaling operator.
 
StiffArray< dim, uint > & operator*= (const StiffArray< dim, uint > &a)
 Multiplication operator.
 
StiffArray< dim, uint > & operator/= (const uint n)
 Division operator.
 
StiffArray< dim, uint > & operator+= (const uint n)
 Addition operator.
 
StiffArray< dim, uint > & operator-= (const uint n)
 Subtraction operator.
 
StiffArray< dim, uint > & apply (uint &fnc(uint &))
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

template<uint dim>
class concepts::MultiIndex< dim >

Definition at line 43 of file multiArray.hh.

Constructor & Destructor Documentation

◆ MultiIndex() [1/4]

template<uint dim>
concepts::MultiIndex< dim >::MultiIndex ( )
inline

Constructor.

Definition at line 46 of file multiArray.hh.

◆ MultiIndex() [2/4]

template<uint dim>
concepts::MultiIndex< dim >::MultiIndex ( const uint dft)
inline

Constructor.

Parameters
dftDefault value. This is used in the first allocation and not in subsequent allocations.

Definition at line 52 of file multiArray.hh.

◆ MultiIndex() [3/4]

template<uint dim>
concepts::MultiIndex< dim >::MultiIndex ( const uint  dft[])

Constructor.

Parameters
dftC array of size sz.

Take care for the length of the C array.

Definition at line 78 of file multiArray.hh.

◆ MultiIndex() [4/4]

template<uint dim>
concepts::MultiIndex< dim >::MultiIndex ( const MultiIndex< dim > &  a)
inline

Copy constructor.

Definition at line 62 of file multiArray.hh.

◆ ~MultiIndex()

template<uint dim>
virtual concepts::MultiIndex< dim >::~MultiIndex ( )
inlinevirtual

Definition at line 63 of file multiArray.hh.

Member Function Documentation

◆ apply()

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::apply ( uint &  fncF &)
inlineinherited

Application operator to each component, e.g. std::sin or std::conj

Definition at line 140 of file stiffArray.hh.

◆ array_data()

Array< uint > concepts::StiffArray< dim, uint >::array_data ( ) const
inlineinherited

Definition at line 92 of file stiffArray.hh.

◆ data() [1/2]

uint * concepts::StiffArray< dim, uint >::data ( )
inlineinherited

Returns a pointer to the data in the array.

Definition at line 85 of file stiffArray.hh.

◆ data() [2/2]

const uint * concepts::StiffArray< dim, uint >::data ( ) const
inlineinherited

Returns a pointer to the data in the array.

Definition at line 87 of file stiffArray.hh.

◆ info()

template<uint dim>
std::ostream & concepts::MultiIndex< dim >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::StiffArray< dim, uint >.

Definition at line 103 of file multiArray.hh.

◆ length()

uint concepts::StiffArray< dim, uint >::length ( )
inlineinherited

Definition at line 77 of file stiffArray.hh.

◆ operator Array< uint >()

concepts::StiffArray< dim, uint >::operator Array< uint > ( ) const
inlineinherited

Definition at line 90 of file stiffArray.hh.

◆ operator const uint *()

concepts::StiffArray< dim, uint >::operator const uint * ( ) const
inlineinherited

Returns a pointer to the data in the array.

Definition at line 83 of file stiffArray.hh.

◆ operator uint *()

concepts::StiffArray< dim, uint >::operator uint * ( )
inlineinherited

Returns a pointer to the data in the array.

Definition at line 81 of file stiffArray.hh.

◆ operator!=()

template<uint dim>
bool concepts::MultiIndex< dim >::operator!= ( const MultiIndex< dim > &  a) const

Comparison operator.

Definition at line 98 of file multiArray.hh.

◆ operator*=() [1/2]

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::operator*= ( const StiffArray< dim, uint > &  a)
inlineinherited

Multiplication operator.

Definition at line 133 of file stiffArray.hh.

◆ operator*=() [2/2]

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::operator*= ( const uint  n)
inlineinherited

Scaling operator.

Definition at line 108 of file stiffArray.hh.

◆ operator+=()

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::operator+= ( const uint  n)
inlineinherited

Addition operator.

Definition at line 123 of file stiffArray.hh.

◆ operator-=()

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::operator-= ( const uint  n)
inlineinherited

Subtraction operator.

Definition at line 128 of file stiffArray.hh.

◆ operator/=()

StiffArray< dim, uint > & concepts::StiffArray< dim, uint >::operator/= ( const uint  n)
inlineinherited

Division operator.

Definition at line 113 of file stiffArray.hh.

◆ operator==()

template<uint dim>
bool concepts::MultiIndex< dim >::operator== ( const MultiIndex< dim > &  a) const

Comparison operator.

Comparison operator

Definition at line 91 of file multiArray.hh.

◆ operator[]() [1/2]

uint & concepts::StiffArray< dim, uint >::operator[] ( const int  i)
inlineinherited

Index operator.

Definition at line 101 of file stiffArray.hh.

◆ operator[]() [2/2]

const uint & concepts::StiffArray< dim, uint >::operator[] ( const int  i) const
inlineinherited

Index operator.

Definition at line 95 of file stiffArray.hh.

◆ zeros()

void concepts::StiffArray< dim, uint >::zeros ( )
inlineinherited

Fills the memory with zeros.

Definition at line 79 of file stiffArray.hh.


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