MatrixState Struct Reference

Simulation state which include only a matrix. More...

#include <matrix.h>

Inheritance diagram for MatrixState:

Collaboration diagram for MatrixState:

Public Types
enum	{ maxsize =6 }
enum	param_t {   PS_X, PS_PX, PS_Y, PS_PY,   PS_S, PS_PS }
typedef boost::numeric::ublas::matrix < double, boost::numeric::ublas::row_major, boost::numeric::ublas::bounded_array < double, maxsize *maxsize > >	value_t

Public Member Functions
	MatrixState (const Config &c)
void	assign (const StateBase &other)
virtual void	show (std::ostream &strm, int level) const
virtual bool	getArray (unsigned idx, ArrayInfo &Info)
	Introspect named parameter of the derived class. More...
virtual MatrixState *	clone () const

Public Attributes
value_t	state
Public Attributes inherited from StateBase
size_t	next_elem
double	pos
	absolute longitudinal position at end of Element

Protected Member Functions
	MatrixState (const MatrixState &o, clone_tag)
Protected Member Functions inherited from StateBase
	StateBase (const Config &c)
	StateBase (const StateBase &c, clone_tag)
	For use in clone()

Detailed Description

Simulation state which include only a matrix.

Definition at line 13 of file matrix.h.

Member Function Documentation

void MatrixState::assign ( const StateBase &  other )

virtual

virtual equivalent to operator=() Should only be used with another State originating from the same Machine from Machine::allocState() or clone().

Implements StateBase.

Definition at line 45 of file linear.cpp.

virtual MatrixState* MatrixState::clone ( ) const

inlinevirtual

Allocate a new instance which is a copy of this one. Caller is responsible to delete the returned pointer

Implements StateBase.

Definition at line 36 of file matrix.h.

bool MatrixState::getArray ( unsigned  index, ArrayInfo &  Info  )

virtual

Introspect named parameter of the derived class.

Parameters

idx	The index of the parameter
Info	mailbox to be filled with information about this paramter

Returns

true if 'idx' is valid and Info was filled in, otherwise false

To introspect call this with index increasing from zero until false is returned.

Sub-classes are required to maintain a fixed number of parameters. The same ArrayInfo::name should alwaysbe returned for a given index. Similarly ArrayInfo::ndim and ArrayInfo.type should not change.

ArrayInfo::ptr, ArrayInfo::dim, ArrayInfo::stride are allowed to change when the state is passed to Machine::propagate().

Therefore, if getArray() for an instance has returned true for some index, then a caller may assume that all future calls to getArray() for this instance will also return true. However, the caller must still re-call getArray() in future as the storage and sizes may have changed.

Reimplemented from StateBase.

Definition at line 59 of file linear.cpp.

void MatrixState::show ( std::ostream &  , int  level  ) const

virtual

Print information about the state. level is a hint as to the verbosity expected by the caller.

Reimplemented from StateBase.

Definition at line 54 of file linear.cpp.

---

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

• src/flame/state/matrix.h
• src/linear.cpp