PlasCom2  1.0
XPACC Multi-physics simluation application
Public Member Functions | Private Attributes | List of all members
Stepper< DataType > Class Template Reference

Type agnostic stepper. More...

Detailed Description

template<typename DataType>
class ix::primitive::Stepper< DataType >

Type agnostic stepper.

Definition at line 106 of file PrimitiveTypes.H.

#include <PrimitiveTypes.H>

Public Member Functions

virtual ~Stepper ()
 
 Stepper ()
 
 Stepper (const DataType &l, const DataType &u, size_t N)
 
 Stepper (const DataType &l, const DataType &u, const DataType &interval)
 
virtual DataType Init (const DataType &l, const DataType &u, size_t N)
 
virtual DataType Init (const DataType &l, const DataType &u, const DataType &interval)
 
virtual size_t GetStep () const
 
virtual DataType GetNext ()
 
virtual DataType Value () const
 
virtual DataType Value (size_t n) const
 
virtual DataType Restart ()
 
virtual DataType Refine (size_t N)
 
virtual DataType Reset (size_t N)
 
virtual void Finish ()
 
virtual DataType operator++ ()
 
virtual DataType operator++ (int)
 
virtual DataType operator-- ()
 
virtual DataType operator-- (int)
 
virtual bool Done () const
 
virtual bool Good () const
 
virtual bool Bad () const
 
virtual void SetBad ()
 
virtual const std::vector< DataType > & Values ()
 

Private Attributes

bool _good
 
bool _done
 
std::pair< DataType, DataType > _limits
 
std::vector< DataType > _values
 
std::vector< DataType >::iterator _curstep
 
Collaboration diagram for Stepper< DataType >:
[legend]

Constructor & Destructor Documentation

◆ ~Stepper()

virtual ~Stepper ( )
inlinevirtual

Definition at line 114 of file PrimitiveTypes.H.

◆ Stepper() [1/3]

Stepper ( )
inline

Definition at line 115 of file PrimitiveTypes.H.

◆ Stepper() [2/3]

Stepper ( const DataType &  l,
const DataType &  u,
size_t  N 
)
inline

Definition at line 116 of file PrimitiveTypes.H.

◆ Stepper() [3/3]

Stepper ( const DataType &  l,
const DataType &  u,
const DataType &  interval 
)
inline

Definition at line 120 of file PrimitiveTypes.H.

Member Function Documentation

◆ Bad()

virtual bool Bad ( ) const
inlinevirtual

Definition at line 185 of file PrimitiveTypes.H.

◆ Done()

virtual bool Done ( ) const
inlinevirtual

Definition at line 179 of file PrimitiveTypes.H.

◆ Finish()

virtual void Finish ( )
inlinevirtual

Definition at line 166 of file PrimitiveTypes.H.

◆ GetNext()

virtual DataType GetNext ( )
inlinevirtual

Definition at line 152 of file PrimitiveTypes.H.

◆ GetStep()

virtual size_t GetStep ( ) const
inlinevirtual

Definition at line 151 of file PrimitiveTypes.H.

◆ Good()

virtual bool Good ( ) const
inlinevirtual

Definition at line 184 of file PrimitiveTypes.H.

◆ Init() [1/2]

virtual DataType Init ( const DataType &  l,
const DataType &  u,
size_t  N 
)
inlinevirtual

Definition at line 124 of file PrimitiveTypes.H.

◆ Init() [2/2]

virtual DataType Init ( const DataType &  l,
const DataType &  u,
const DataType &  interval 
)
inlinevirtual

Definition at line 138 of file PrimitiveTypes.H.

◆ operator++() [1/2]

virtual DataType operator++ ( )
inlinevirtual

Definition at line 171 of file PrimitiveTypes.H.

◆ operator++() [2/2]

virtual DataType operator++ ( int  )
inlinevirtual

Definition at line 175 of file PrimitiveTypes.H.

◆ operator--() [1/2]

virtual DataType operator-- ( )
inlinevirtual

Definition at line 177 of file PrimitiveTypes.H.

◆ operator--() [2/2]

virtual DataType operator-- ( int  )
inlinevirtual

Definition at line 178 of file PrimitiveTypes.H.

◆ Refine()

virtual DataType Refine ( size_t  N)
inlinevirtual

Definition at line 164 of file PrimitiveTypes.H.

◆ Reset()

virtual DataType Reset ( size_t  N)
inlinevirtual

Definition at line 165 of file PrimitiveTypes.H.

◆ Restart()

virtual DataType Restart ( )
inlinevirtual

Definition at line 159 of file PrimitiveTypes.H.

◆ SetBad()

virtual void SetBad ( )
inlinevirtual

Definition at line 186 of file PrimitiveTypes.H.

◆ Value() [1/2]

virtual DataType Value ( ) const
inlinevirtual

Definition at line 153 of file PrimitiveTypes.H.

◆ Value() [2/2]

virtual DataType Value ( size_t  n) const
inlinevirtual

Definition at line 154 of file PrimitiveTypes.H.

◆ Values()

virtual const std::vector<DataType>& Values ( )
inlinevirtual

Definition at line 187 of file PrimitiveTypes.H.

Member Data Documentation

◆ _curstep

std::vector<DataType>::iterator _curstep
private

Definition at line 112 of file PrimitiveTypes.H.

◆ _done

bool _done
private

Definition at line 109 of file PrimitiveTypes.H.

◆ _good

bool _good
private

Definition at line 108 of file PrimitiveTypes.H.

◆ _limits

std::pair<DataType,DataType> _limits
private

Definition at line 110 of file PrimitiveTypes.H.

◆ _values

std::vector<DataType> _values
private

Definition at line 111 of file PrimitiveTypes.H.

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