Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::ArrayMatrixTranspose< F, dim > Class Template Reference

#include <arrays.hh>

Inheritance diagram for concepts::ArrayMatrixTranspose< F, dim >:
concepts::Array< concepts::Mapping< F, dim > >

Public Member Functions

 ArrayMatrixTranspose (const concepts::Array< concepts::Mapping< F, dim > > *array)
 
void resize (const uint sz)
 
void resizePreserve (const uint sz)
 
void zeros ()
 Fills the memory with zeros.
 
 operator concepts::Mapping< F, dim > * ()
 Returns a pointer to the array.
 
 operator const concepts::Mapping< F, dim > * () const
 Returns a pointer to the array.
 
const concepts::Mapping< F, dim > & operator[] (const int i) const
 Index operator.
 
concepts::Mapping< F, dim > & operator[] (const int i)
 Index operator.
 
Array< concepts::Mapping< F, dim > > & operator*= (const G n)
 Scaling operator.
 
Array< concepts::Mapping< F, dim > > & operator*= (const Array< H > &a)
 Multiplication operator.
 
Array< concepts::Mapping< F, dim > > & operator+= (const concepts::Mapping< F, dim > n)
 Addition operator.
 
Array< concepts::Mapping< F, dim > > & operator+= (const Array< H > &a)
 Addition operator.
 
Array< concepts::Mapping< F, dim > > & operator-= (const concepts::Mapping< F, dim > n)
 Subtraction operator.
 
Array< concepts::Mapping< F, dim > > & operator-= (const Array< H > &a)
 Subtraction operator.
 
Array< concepts::Mapping< F, dim > > operator- () const
 Negation operator.
 
Array< concepts::Mapping< F, dim > > & apply (concepts::Mapping< F, dim > &fnc(concepts::Mapping< F, dim > &))
 
Array< concepts::Mapping< F, dim > > & apply (const Array< H > &a, concepts::Mapping< F, dim > fnc(const H &))
 
Array< concepts::Mapping< F, dim > > & apply (const Array< H > &a, concepts::Mapping< F, dim > fnc(const H &, const concepts::Mapping< F, dim > &))
 
uint size () const
 Returns the requested size of the array.
 
uint cursize () const
 Returns the size of the allocated memory.
 
int memory () const
 Returns the memory usage in bytes.
 
Array< concepts::Mapping< F, dim > > & reverse ()
 Reverse the order of the entries.
 
std::ostream & info (std::ostream &os) const
 

Protected Attributes

concepts::Mapping< F, dim > * data_
 Data.
 
uint size_
 Current real size of the array.
 
uint n_
 Requested size of the array.
 

Detailed Description

template<class F, int dim>
class concepts::ArrayMatrixTranspose< F, dim >

Class, which calculates the transpose matrix for each element of the array.

Author
Kersten Schmidt, 2006

Definition at line 65 of file arrays.hh.

Constructor & Destructor Documentation

◆ ArrayMatrixTranspose()

template<class F , int dim>
concepts::ArrayMatrixTranspose< F, dim >::ArrayMatrixTranspose ( const concepts::Array< concepts::Mapping< F, dim > > *  array)
inline

Definition at line 67 of file arrays.hh.

Member Function Documentation

◆ apply() [1/3]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::apply ( concepts::Mapping< F, dim > &  fncF &)
inlineinherited

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

Definition at line 219 of file array.hh.

◆ apply() [2/3]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::apply ( const Array< H > &  a,
concepts::Mapping< F, dim >  fncconst H & 
)
inlineinherited

Application operator to each component

Each array value is the function applied to the appropiate array value in a.

  @param a   Array with elements of type H
  @param fnc Function which maps from H to F

Definition at line 233 of file array.hh.

◆ apply() [3/3]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::apply ( const Array< H > &  a,
concepts::Mapping< F, dim >  fncconst H &, const F & 
)
inlineinherited

Application operator to each component

Each array value is the function applied to the appropiate array value in a and to the old array value.

  @param a   Array with elements of type H
  @param fnc Function which maps from (H,F) to F

Definition at line 249 of file array.hh.

◆ cursize()

uint concepts::Array< concepts::Mapping< F, dim > >::cursize ( ) const
inlineinherited

Returns the size of the allocated memory.

Definition at line 262 of file array.hh.

◆ info()

std::ostream & concepts::Array< concepts::Mapping< F, dim > >::info ( std::ostream &  os) const
inherited

Definition at line 270 of file array.hh.

◆ memory()

int concepts::Array< concepts::Mapping< F, dim > >::memory ( ) const
inlineinherited

Returns the memory usage in bytes.

Definition at line 265 of file array.hh.

◆ operator concepts::Mapping< F, dim > *()

concepts::Array< concepts::Mapping< F, dim > >::operator concepts::Mapping< F, dim > * ( )
inlineinherited

Returns a pointer to the array.

Definition at line 131 of file array.hh.

◆ operator const concepts::Mapping< F, dim > *()

concepts::Array< concepts::Mapping< F, dim > >::operator const concepts::Mapping< F, dim > * ( ) const
inlineinherited

Returns a pointer to the array.

Definition at line 133 of file array.hh.

◆ operator*=() [1/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator*= ( const Array< H > &  a)
inlineinherited

Multiplication operator.

Definition at line 158 of file array.hh.

◆ operator*=() [2/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator*= ( const G  n)
inlineinherited

Scaling operator.

Definition at line 150 of file array.hh.

◆ operator+=() [1/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator+= ( const Array< H > &  a)
inlineinherited

Addition operator.

Definition at line 191 of file array.hh.

◆ operator+=() [2/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator+= ( const concepts::Mapping< F, dim >  n)
inlineinherited

Addition operator.

Definition at line 185 of file array.hh.

◆ operator-()

Array< concepts::Mapping< F, dim > > concepts::Array< concepts::Mapping< F, dim > >::operator- ( ) const
inlineinherited

Negation operator.

Definition at line 211 of file array.hh.

◆ operator-=() [1/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator-= ( const Array< H > &  a)
inlineinherited

Subtraction operator.

Definition at line 204 of file array.hh.

◆ operator-=() [2/2]

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::operator-= ( const concepts::Mapping< F, dim >  n)
inlineinherited

Subtraction operator.

Definition at line 198 of file array.hh.

◆ operator[]() [1/2]

concepts::Mapping< F, dim > & concepts::Array< concepts::Mapping< F, dim > >::operator[] ( const int  i)
inlineinherited

Index operator.

Definition at line 142 of file array.hh.

◆ operator[]() [2/2]

const concepts::Mapping< F, dim > & concepts::Array< concepts::Mapping< F, dim > >::operator[] ( const int  i) const
inlineinherited

Index operator.

Definition at line 136 of file array.hh.

◆ resize()

void concepts::Array< concepts::Mapping< F, dim > >::resize ( const uint  sz)
inherited

Resizes the array. A reallocation occurs only if the requested space is not available, ie. making the array smaller does not result in a reallocation. If a reallocation occurs, the data is not preserved.

Definition at line 122 of file array.hh.

◆ resizePreserve()

void concepts::Array< concepts::Mapping< F, dim > >::resizePreserve ( const uint  sz)
inherited

Resizes the array. Basically, it does the same as resize. But, if a reallocation occurs, the data is preserved.

Definition at line 126 of file array.hh.

◆ reverse()

Array< concepts::Mapping< F, dim > > & concepts::Array< concepts::Mapping< F, dim > >::reverse ( )
inherited

Reverse the order of the entries.

Definition at line 268 of file array.hh.

◆ size()

uint concepts::Array< concepts::Mapping< F, dim > >::size ( ) const
inlineinherited

Returns the requested size of the array.

Definition at line 259 of file array.hh.

◆ zeros()

void concepts::Array< concepts::Mapping< F, dim > >::zeros ( )
inlineinherited

Fills the memory with zeros.

Definition at line 128 of file array.hh.

Member Data Documentation

◆ data_

concepts::Mapping< F, dim > * concepts::Array< concepts::Mapping< F, dim > >::data_
protectedinherited

Data.

Definition at line 273 of file array.hh.

◆ n_

uint concepts::Array< concepts::Mapping< F, dim > >::n_
protectedinherited

Requested size of the array.

Definition at line 277 of file array.hh.

◆ size_

uint concepts::Array< concepts::Mapping< F, dim > >::size_
protectedinherited

Current real size of the array.

Definition at line 275 of file array.hh.


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