biu::DistanceEnergyFunction Class Reference
#include <DistanceEnergyFunction.hh>
Inheritance diagram for biu::DistanceEnergyFunction:
Detailed Description
An energy function that evaluates the energy contribution of two monomers depending on their type and distance.It provides the distance based energy for elements of a specified alphabet.
Definition at line 19 of file DistanceEnergyFunction.hh.
Public Member Functions | |
| virtual const Alphabet *const | getAlphabet () const=0 |
| virtual double | getEnergy (const Alphabet::AlphElem &seq_i, const Alphabet::AlphElem &seq_j, const DblPoint &cor_i, const DblPoint &cor_j) const=0 |
| virtual double | getEnergy (const Alphabet::AlphElem &seq_i, const Alphabet::AlphElem &seq_j, const IntPoint &cor_i, const IntPoint &cor_j) const=0 |
| virtual double | getEnergy (const Alphabet::AlphElem &seq_i, const Alphabet::AlphElem &seq_j, const double &distance) const=0 |
| virtual bool | operator!= (const DistanceEnergyFunction &cef2) const=0 |
| virtual bool | operator== (const DistanceEnergyFunction &cef2) const=0 |
| virtual | ~DistanceEnergyFunction () |
Constructor & Destructor Documentation
| biu::DistanceEnergyFunction::~DistanceEnergyFunction | ( | ) | [virtual] |
Definition at line 7 of file DistanceEnergyFunction.cc.
Member Function Documentation
| virtual const Alphabet* const biu::DistanceEnergyFunction::getAlphabet | ( | ) | const [pure virtual] |
Access to the alphabet this energy function is based on.
- Returns:
- the alphabet in use
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
| virtual double biu::DistanceEnergyFunction::getEnergy | ( | const Alphabet::AlphElem & | seq_i, | |
| const Alphabet::AlphElem & | seq_j, | |||
| const DblPoint & | cor_i, | |||
| const DblPoint & | cor_j | |||
| ) | const [pure virtual] |
Returns the energy contribution of two elements of the alphabet with given coordinates.
- Parameters:
-
seq_i,seq_j have to be elements of the specified alphabet. cor_i,cor_j the corresponding coordinates of the two monomers to evaluate
- Returns:
- the energy contribution
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
| virtual double biu::DistanceEnergyFunction::getEnergy | ( | const Alphabet::AlphElem & | seq_i, | |
| const Alphabet::AlphElem & | seq_j, | |||
| const IntPoint & | cor_i, | |||
| const IntPoint & | cor_j | |||
| ) | const [pure virtual] |
Returns the energy contribution of two elements of the alphabet with given coordinates.
- Parameters:
-
seq_i,seq_j have to be elements of the specified alphabet. cor_i,cor_j the corresponding coordinates of the two monomers to evaluate
- Returns:
- the energy contribution
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
| virtual double biu::DistanceEnergyFunction::getEnergy | ( | const Alphabet::AlphElem & | seq_i, | |
| const Alphabet::AlphElem & | seq_j, | |||
| const double & | distance | |||
| ) | const [pure virtual] |
Returns the energy contribution of two elements of the alphabet that are in a certain distance.
- Parameters:
-
seq_i,seq_j have to be elements of the specified alphabet. distance the distance of the two monomers to evaluate
- Returns:
- the energy contribution
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
| virtual bool biu::DistanceEnergyFunction::operator!= | ( | const DistanceEnergyFunction & | cef2 | ) | const [pure virtual] |
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
| virtual bool biu::DistanceEnergyFunction::operator== | ( | const DistanceEnergyFunction & | cef2 | ) | const [pure virtual] |
Implemented in biu::ContactEnergyFunction, and biu::IntervalEnergyFunction.
The documentation for this class was generated from the following files:
- src/biu/DistanceEnergyFunction.hh
- src/biu/DistanceEnergyFunction.cc