biu::ContactEnergyFunction Class Reference
#include <ContactEnergyFunction.hh>
Detailed Description
This class manages tasks on contact energy functions.It provides the contact energy for elements of a specified alphabet.
Definition at line 21 of file ContactEnergyFunction.hh.
Public Member Functions | |
| ContactEnergyFunction (const Alphabet *const alphabet, const EnergyMatrix *const energyMat) | |
| virtual const Alphabet *const | getAlphabet () const |
| virtual double | getContactEnergy (const Alphabet::AlphElem &first, const Alphabet::AlphElem &second) const |
| virtual bool | operator!= (const ContactEnergyFunction &cef2) const |
| virtual bool | operator== (const ContactEnergyFunction &cef2) const |
| virtual | ~ContactEnergyFunction () |
Private Attributes | |
| const Alphabet *const | alphabet |
| const EnergyMatrix *const | energyMat |
Constructor & Destructor Documentation
| biu::ContactEnergyFunction::ContactEnergyFunction | ( | const Alphabet *const | alphabet, | |
| const EnergyMatrix *const | energyMat | |||
| ) |
Constructs a new contact energy function for the given alphabet.
The alphabet elements of type AlphElem are mapped to the EnergyMatrix indices via the getIndex(..) of the Alphabet class.
- Parameters:
-
alphabet the alphabet the energy function supports energyMat the contact energy matrix used. NOTE: has to have the same dimensions as the alphabet has elements!
Definition at line 7 of file ContactEnergyFunction.cc.
| biu::ContactEnergyFunction::~ContactEnergyFunction | ( | ) | [virtual] |
Definition at line 17 of file ContactEnergyFunction.cc.
Member Function Documentation
| virtual const Alphabet* const biu::ContactEnergyFunction::getAlphabet | ( | ) | const [inline, virtual] |
Returns the alphabet this energy function is based on.
Definition at line 55 of file ContactEnergyFunction.hh.
| double biu::ContactEnergyFunction::getContactEnergy | ( | const Alphabet::AlphElem & | first, | |
| const Alphabet::AlphElem & | second | |||
| ) | const [virtual] |
Returns the contact energy of two elements of the alphabet.
- Parameters:
-
first,second have to be elements of the specified alphabet.
Definition at line 22 of file ContactEnergyFunction.cc.
| bool biu::ContactEnergyFunction::operator!= | ( | const ContactEnergyFunction & | cef2 | ) | const [virtual] |
Definition at line 39 of file ContactEnergyFunction.cc.
| bool biu::ContactEnergyFunction::operator== | ( | const ContactEnergyFunction & | cef2 | ) | const [virtual] |
Definition at line 31 of file ContactEnergyFunction.cc.
Field Documentation
const Alphabet* const biu::ContactEnergyFunction::alphabet [private] |
Definition at line 25 of file ContactEnergyFunction.hh.
const EnergyMatrix* const biu::ContactEnergyFunction::energyMat [private] |
Definition at line 26 of file ContactEnergyFunction.hh.
The documentation for this class was generated from the following files:
- src/biu/ContactEnergyFunction.hh
- src/biu/ContactEnergyFunction.cc