bpp::AAMassIndex Class Reference

Mass (dalton) of each amino acid, according to http://www.imb-jena.de/IMAGE_AA.html. More...

#include <Bpp/Seq/AlphabetIndex/AAMassIndex.h>

Inheritance diagram for bpp::AAMassIndex:

Collaboration diagram for bpp::AAMassIndex:

Public Member Functions
	AAMassIndex ()
virtual	~AAMassIndex ()
AAMassIndex *	clone () const
double	getIndex (int state) const throw (BadIntException)
	Get the index associated to a state. More...
double	getIndex (const std::string &state) const throw (BadCharException)
	Get the index associated to a state. More...
std::vector< double > *	getIndexVector () const
const Alphabet *	getAlphabet () const
	Get the alphabet associated to this index. More...

Private Attributes
std::vector< double >	mass_

Detailed Description

Mass (dalton) of each amino acid, according to http://www.imb-jena.de/IMAGE_AA.html.

Definition at line 52 of file AAMassIndex.h.

Constructor & Destructor Documentation

AAMassIndex()

bpp::AAMassIndex::AAMassIndex ( )

inline

Definition at line 59 of file AAMassIndex.h.

References mass_.

Referenced by clone().

~AAMassIndex()

virtual bpp::AAMassIndex::~AAMassIndex ( )

inlinevirtual

Definition at line 85 of file AAMassIndex.h.

Member Function Documentation

clone()

AAMassIndex* bpp::AAMassIndex::clone ( ) const

inlinevirtual

Implements bpp::AlphabetIndex1.

Definition at line 87 of file AAMassIndex.h.

References AAMassIndex().

getAlphabet()

const Alphabet* bpp::AAMassIndex::getAlphabet ( ) const

inlinevirtual

Get the alphabet associated to this index.

Returns

Alphabet The alphabet associated to this index.

Implements bpp::AlphabetIndex1.

Definition at line 103 of file AAMassIndex.h.

References bpp::AlphabetTools::PROTEIN_ALPHABET.

getIndex() [1/2]

double bpp::AAMassIndex::getIndex ( int  state ) const throw ( BadIntException )

inlinevirtual

Get the index associated to a state.

Parameters

state

The state to consider, as a int value.

Returns

The index associated to the state

Implements bpp::AlphabetIndex1.

Definition at line 90 of file AAMassIndex.h.

References mass_, and bpp::AlphabetTools::PROTEIN_ALPHABET.

getIndex() [2/2]

double bpp::AAMassIndex::getIndex ( const std::string &  state ) const throw ( BadCharException )

inlinevirtual

Get the index associated to a state.

Parameters

state

The state to consider, as a string value.

Returns

The index associated to the state

Implements bpp::AlphabetIndex1.

Definition at line 96 of file AAMassIndex.h.

References bpp::LetterAlphabet::charToInt(), mass_, and bpp::AlphabetTools::PROTEIN_ALPHABET.

getIndexVector()

std::vector<double>* bpp::AAMassIndex::getIndexVector ( ) const

inlinevirtual

Returns

A vector object with all indices.

Implements bpp::AlphabetIndex1.

Definition at line 101 of file AAMassIndex.h.

References mass_.

Member Data Documentation

mass_

std::vector<double> bpp::AAMassIndex::mass_

private

Definition at line 56 of file AAMassIndex.h.

Referenced by AAMassIndex(), getIndex(), and getIndexVector().

---

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

• Bpp/Seq/AlphabetIndex/AAMassIndex.h