biu::PullMoveSet Class Reference
#include <PullMoveSet.hh>
Inheritance diagram for biu::PullMoveSet:
Detailed Description
This class handles pull moves on LatticeProtein objects.
Definition at line 16 of file PullMoveSet.hh.
Public Member Functions | |
| virtual LatticeProtein * | applyMove (const LatticeProtein *const todo, const size_t moveIndex) |
| virtual LatticeProtein * | applyMoveInPlace (LatticeProtein *const todo, const size_t moveIndex) |
| PullMoveSet * | clone () |
| virtual const PullMoveDecoder *const | getDecoder (void) const |
| size_t | getMoveNumber (const LatticeProtein *const lp) const |
| PullMoveSet & | operator= (const PullMoveSet &moveSet2) |
| PullMoveSet (const PullMoveSet &moveSet) | |
| PullMoveSet (PullMoveDecoder *decoder, const bool decoderIsShared) | |
| PullMoveSet (const LatticeModel *lattice) | |
| virtual LatticeProtein * | undoLastMove (LatticeProtein *toUndo) |
| virtual | ~PullMoveSet () |
Protected Attributes | |
| PullMoveSet::PullMoveDecoder * | decoder |
| const bool | decoderIsShared |
| const LatticeModel * | lattice |
| biu::PullMoveSet::UndoRecord | undoRec |
Data Structures | |
| class | PullMoveDecoder |
| class | RelativeInt |
| struct | UndoRecord |
Constructor & Destructor Documentation
| biu::PullMoveSet::PullMoveSet | ( | const LatticeModel * | lattice | ) |
Constructs a PullMoveSet object operating on the LatticeModel lattice.
- Parameters:
-
lattice the lattice in use
Definition at line 181 of file PullMoveSet.cc.
| biu::PullMoveSet::PullMoveSet | ( | PullMoveDecoder * | decoder, | |
| const bool | decoderIsShared | |||
| ) |
Constructs a PullMoveSet object operating lattice model represented by the provided decoder.
- Parameters:
-
decoder the decoder to use decoderIsShared whether or not the decoder is shared among all derived instances or has to be copied
Definition at line 189 of file PullMoveSet.cc.
| biu::PullMoveSet::PullMoveSet | ( | const PullMoveSet & | moveSet | ) |
Definition at line 206 of file PullMoveSet.cc.
| biu::PullMoveSet::~PullMoveSet | ( | ) | [virtual] |
Definition at line 233 of file PullMoveSet.cc.
Member Function Documentation
| LatticeProtein * biu::PullMoveSet::applyMove | ( | const LatticeProtein *const | todo, | |
| const size_t | moveIndex | |||
| ) | [virtual] |
Applies a pull move to the given LatticeProtein on the specified position and returns a new LatticeProtein object as result.
- Parameters:
-
todo the initial state moveIndex the move index (has to be less than the return value of getMoveNumber())
- Returns:
- a new LatticeProtein object neighbored to the todo object
Implements biu::LatticeMoveSet.
Definition at line 240 of file PullMoveSet.cc.
| LatticeProtein * biu::PullMoveSet::applyMoveInPlace | ( | LatticeProtein *const | todo, | |
| const size_t | moveIndex | |||
| ) | [virtual] |
Applies a pull move to the given LatticeProtein on the specified position INPLACE and returns the modified object as result.
- Parameters:
-
todo the initial state to modify moveIndex the move index (has to be less than the return value of getMoveNumber())
- Returns:
- the modified LatticeProtein or NULL if the move is not valid
Implements biu::LatticeMoveSet.
Definition at line 254 of file PullMoveSet.cc.
| PullMoveSet * biu::PullMoveSet::clone | ( | ) | [virtual] |
| const PullMoveSet::PullMoveDecoder *const biu::PullMoveSet::getDecoder | ( | void | ) | const [virtual] |
Access to the used PullMoveDecoder.
- Returns:
- the current decode in use
Definition at line 518 of file PullMoveSet.cc.
| size_t biu::PullMoveSet::getMoveNumber | ( | const LatticeProtein *const | lp | ) | const [virtual] |
Returns number of moves that can be applied to the given lattice.
Implements biu::LatticeMoveSet.
Definition at line 466 of file PullMoveSet.cc.
| PullMoveSet & biu::PullMoveSet::operator= | ( | const PullMoveSet & | moveSet2 | ) |
Definition at line 218 of file PullMoveSet.cc.
| LatticeProtein * biu::PullMoveSet::undoLastMove | ( | LatticeProtein * | toUndo | ) | [virtual] |
Undo of last pull move performed on LatticeProtein toUndo. Undo is performed in place!
Implements biu::LatticeMoveSet.
Definition at line 475 of file PullMoveSet.cc.
Field Documentation
PullMoveSet::PullMoveDecoder* biu::PullMoveSet::decoder [protected] |
const bool biu::PullMoveSet::decoderIsShared [protected] |
whether or not the decoder is shared and has to be copied or not
Definition at line 231 of file PullMoveSet.hh.
const LatticeModel* biu::LatticeMoveSet::lattice [protected, inherited] |
the lattice model this move set bases on
Definition at line 24 of file LatticeMoveSet.hh.
struct biu::PullMoveSet::UndoRecord biu::PullMoveSet::undoRec [protected] |
The documentation for this class was generated from the following files:
- src/biu/PullMoveSet.hh
- src/biu/PullMoveSet.cc