ppALIGN API documentation

Workspace< CELL > Class Template Reference

#include <checkpoint.hpp>

List of all members.

Public Types

container types



typedef CELL cell_t
typedef std::vector< cell_t > parent_t
iterators for Workspace



typedef std::vector< cell_t >
::iterator 		iterator
typedef std::vector< cell_t >
::const_iterator 		const_iterator
typedef std::vector< cell_t >
::reverse_iterator 		reverse_iterator
typedef std::vector< cell_t >
::const_reverse_iterator 		const_reverse_iterator

Public Member Functions

 Workspace (size_t n_cells)
void SetupTable (size_t n_rows, size_t n_cols)
size_t Rows ()
size_t Cols ()
iterator RowBegin (size_t row)

Detailed Description

template<typename CELL>
class Workspace< CELL >

Workspace for dynamic programing computations. The workspace is realized by a linear vector.

Template Parameters:
CELL the type of the entries in the table, e.g. DynCell<int>, DynCell<xdouble>, DynCellMoments<xdouble>

Definition at line 200 of file checkpoint.hpp.

Member Typedef Documentation

template<typename CELL>
typedef CELL Workspace< CELL >::cell_t

type of the dynamic programming cell.

Definition at line 210 of file checkpoint.hpp.

template<typename CELL>
typedef std::vector<cell_t>::const_iterator Workspace< CELL >::const_iterator

constant iterator type

Definition at line 224 of file checkpoint.hpp.

template<typename CELL>
typedef std::vector<cell_t>::const_reverse_iterator Workspace< CELL >::const_reverse_iterator

const reverse iterator type

Definition at line 230 of file checkpoint.hpp.

template<typename CELL>
typedef std::vector<cell_t>::iterator Workspace< CELL >::iterator

iterator type

Definition at line 221 of file checkpoint.hpp.

template<typename CELL>
typedef std::vector<cell_t> Workspace< CELL >::parent_t

the parent class (std::vector<CELL>)

Definition at line 214 of file checkpoint.hpp.

template<typename CELL>
typedef std::vector<cell_t>::reverse_iterator Workspace< CELL >::reverse_iterator

reverse iterator type

Definition at line 227 of file checkpoint.hpp.

Constructor & Destructor Documentation

template<typename CELL >
Workspace< CELL >::Workspace ( size_t  n_cells  )  [inline]

Constructor.

Parameters:
n_cells number of cells provided that can be used by the algorithms.

Definition at line 272 of file checkpoint.hpp.

Member Function Documentation

template<typename CELL >
size_t Workspace< CELL >::Cols (  )  [inline]
Returns:
number of columns of the full workspace.

Definition at line 297 of file checkpoint.hpp.

template<typename CELL >
Workspace< CELL >::iterator Workspace< CELL >::RowBegin ( size_t  row  )  [inline]
Parameters:
row row index
Returns:
iterator pointing to the begin of the row

Definition at line 303 of file checkpoint.hpp.

template<typename CELL >
size_t Workspace< CELL >::Rows (  )  [inline]
Returns:
number of rows of the full workspace.

Definition at line 291 of file checkpoint.hpp.

template<typename CELL >
void Workspace< CELL >::SetupTable ( size_t  n_rows,
size_t  n_cols 
) [inline]

Define the number of rows and number for cols corresponding to the full workspace.

Parameters:
n_rows number of rows (length of the first sequence)
n_cols number of cols (length of the second sequence)

Definition at line 280 of file checkpoint.hpp.

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