Engine< Dim, T, IndexFunction< Functor > > Class Template Reference

Engine<Dim, T, IndexFunction<Functor> > is a specialization of Engine for IndexFunction. More...

#include <IndexFunctionEngine.h>

Collaboration diagram for Engine< Dim, T, IndexFunction< Functor > >:

Collaboration graph
[legend]

List of all members.

Public Types

enum  { dimensions = Dim }
enum  { hasDataObject = false }
enum  { dynamic = false }
enum  { zeroBased = false }
enum  { multiPatch = false }
typedef IndexFunction< Functor > Tag_t
typedef Engine< Dim, T, Tag_tThis_t
typedef This_t Engine_t
typedef Interval< Dim > Domain_t
typedef DomainLayout< Dim > Layout_t
typedef T Element_t
typedef ErrorType ElementRef_t

Public Member Functions

 Engine ()
 Default constructor (allows subsequent initialization of domain/functor).
 Engine (const Domain_t &domain, const Functor &f=Functor())
 Construct from a domain/layout object and an optional Functor object.
template<class Layout >
 Engine (const Layout &layout, const Functor &f=Functor())
 Engine (const This_t &model)
 Construct from another index-function-engine.
This_toperator= (const This_t &rhs)
 Assign one index-function-engine to another.
const Domain_tdomain () const
 Return/set the domain. Also, return the base domain.
void setDomain (const Domain_t &dom)
int first (int i) const
 Return the first index value for the specified direction.
Layout_t layout () const
 Returns the layout, which is constructed as a DomainLayout.
const Functor & functor () const
 Accessor/modifier.
void setFunctor (const Functor &f)
Element access via ints for speed.
Element_t read (int i0) const
Element_t read (int i0, int i1) const
Element_t read (int i0, int i1, int i2) const
Element_t read (int i0, int i1, int i2, int i3) const
Element_t read (int i0, int i1, int i2, int i3, int i4) const
Element_t read (int i0, int i1, int i2, int i3, int i4, int i5) const
Element_t read (int i0, int i1, int i2, int i3, int i4, int i5, int i6) const
Element_t read (const Loc< 1 > &loc) const
Element_t read (const Loc< 2 > &loc) const
Element_t read (const Loc< 3 > &loc) const
Element_t read (const Loc< 4 > &loc) const
Element_t read (const Loc< 5 > &loc) const
Element_t read (const Loc< 6 > &loc) const
Element_t read (const Loc< 7 > &loc) const


Detailed Description

template<int Dim, class T, class Functor>
class Engine< Dim, T, IndexFunction< Functor > >

Engine<Dim, T, IndexFunction<Functor> > is a specialization of Engine for IndexFunction.

This does all of the usual Engine things:


Member Typedef Documentation

template<int Dim, class T , class Functor >
typedef IndexFunction<Functor> Engine< Dim, T, IndexFunction< Functor > >::Tag_t

template<int Dim, class T , class Functor >
typedef Engine<Dim, T, Tag_t> Engine< Dim, T, IndexFunction< Functor > >::This_t

template<int Dim, class T , class Functor >
typedef This_t Engine< Dim, T, IndexFunction< Functor > >::Engine_t

template<int Dim, class T , class Functor >
typedef Interval<Dim> Engine< Dim, T, IndexFunction< Functor > >::Domain_t

template<int Dim, class T , class Functor >
typedef DomainLayout<Dim> Engine< Dim, T, IndexFunction< Functor > >::Layout_t

template<int Dim, class T , class Functor >
typedef T Engine< Dim, T, IndexFunction< Functor > >::Element_t

template<int Dim, class T , class Functor >
typedef ErrorType Engine< Dim, T, IndexFunction< Functor > >::ElementRef_t


Member Enumeration Documentation

template<int Dim, class T , class Functor >
anonymous enum

Enumerator:
dimensions 

template<int Dim, class T , class Functor >
anonymous enum

Enumerator:
hasDataObject 

template<int Dim, class T , class Functor >
anonymous enum

Enumerator:
dynamic 

template<int Dim, class T , class Functor >
anonymous enum

Enumerator:
zeroBased 

template<int Dim, class T , class Functor >
anonymous enum

Enumerator:
multiPatch 


Constructor & Destructor Documentation

template<int Dim, class T , class Functor >
Engine< Dim, T, IndexFunction< Functor > >::Engine (  )  [inline]

Default constructor (allows subsequent initialization of domain/functor).

template<int Dim, class T , class Functor >
Engine< Dim, T, IndexFunction< Functor > >::Engine ( const Domain_t domain,
const Functor &  f = Functor() 
) [inline, explicit]

Construct from a domain/layout object and an optional Functor object.

template<int Dim, class T , class Functor >
template<class Layout >
Engine< Dim, T, IndexFunction< Functor > >::Engine ( const Layout &  layout,
const Functor &  f = Functor() 
) [inline, explicit]

template<int Dim, class T , class Functor >
Engine< Dim, T, IndexFunction< Functor > >::Engine ( const This_t model  )  [inline]

Construct from another index-function-engine.


Member Function Documentation

template<int Dim, class T , class Functor >
This_t& Engine< Dim, T, IndexFunction< Functor > >::operator= ( const This_t rhs  )  [inline]

Assign one index-function-engine to another.

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1,
int  i2 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1,
int  i2,
int  i3 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1,
int  i2,
int  i3,
int  i4 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1,
int  i2,
int  i3,
int  i4,
int  i5 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( int  i0,
int  i1,
int  i2,
int  i3,
int  i4,
int  i5,
int  i6 
) const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 1 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 2 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 3 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 4 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 5 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 6 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
Element_t Engine< Dim, T, IndexFunction< Functor > >::read ( const Loc< 7 > &  loc  )  const [inline]

template<int Dim, class T , class Functor >
const Domain_t& Engine< Dim, T, IndexFunction< Functor > >::domain (  )  const [inline]

Return/set the domain. Also, return the base domain.

template<int Dim, class T , class Functor >
void Engine< Dim, T, IndexFunction< Functor > >::setDomain ( const Domain_t dom  )  [inline]

template<int Dim, class T , class Functor >
int Engine< Dim, T, IndexFunction< Functor > >::first ( int  i  )  const [inline]

Return the first index value for the specified direction.

References PAssert.

template<int Dim, class T , class Functor >
Layout_t Engine< Dim, T, IndexFunction< Functor > >::layout (  )  const [inline]

Returns the layout, which is constructed as a DomainLayout.

template<int Dim, class T , class Functor >
const Functor& Engine< Dim, T, IndexFunction< Functor > >::functor (  )  const [inline]

Accessor/modifier.

template<int Dim, class T , class Functor >
void Engine< Dim, T, IndexFunction< Functor > >::setFunctor ( const Functor &  f  )  [inline]


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

Generated on Wed Mar 16 06:20:09 2011 for FreePOOMA by  doxygen 1.5.9