bpp-seq  2.2.0
bpp::AASEASup30Index Class Reference

Percentage of amino acids having a Solvent Exposed Area above 30 Angström^2 for each type of amino acid, according to http://prowl.rockefeller.edu/aainfo/access.htm. More...

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

+ Inheritance diagram for bpp::AASEASup30Index:
+ Collaboration diagram for bpp::AASEASup30Index:

Public Member Functions

 AASEASup30Index ()
 
virtual ~AASEASup30Index ()
 
AASEASup30Indexclone () 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 AlphabetgetAlphabet () const
 Get the alphabet associated to this index. More...
 

Private Attributes

std::vector< double > seaSup30_
 

Detailed Description

Percentage of amino acids having a Solvent Exposed Area above 30 Angström^2 for each type of amino acid, according to http://prowl.rockefeller.edu/aainfo/access.htm.

Definition at line 52 of file AASEASup30Index.h.

Constructor & Destructor Documentation

◆ AASEASup30Index()

bpp::AASEASup30Index::AASEASup30Index ( )
inline

Definition at line 59 of file AASEASup30Index.h.

References seaSup30_.

Referenced by clone().

◆ ~AASEASup30Index()

virtual bpp::AASEASup30Index::~AASEASup30Index ( )
inlinevirtual

Definition at line 85 of file AASEASup30Index.h.

Member Function Documentation

◆ clone()

AASEASup30Index* bpp::AASEASup30Index::clone ( ) const
inlinevirtual

Implements bpp::AlphabetIndex1.

Definition at line 87 of file AASEASup30Index.h.

References AASEASup30Index().

◆ getAlphabet()

const Alphabet* bpp::AASEASup30Index::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 AASEASup30Index.h.

References bpp::AlphabetTools::PROTEIN_ALPHABET.

◆ getIndex() [1/2]

double bpp::AASEASup30Index::getIndex ( int  state) const
throw (BadIntException
)
inlinevirtual

Get the index associated to a state.

Parameters
stateThe state to consider, as a int value.
Returns
The index associated to the state

Implements bpp::AlphabetIndex1.

Definition at line 90 of file AASEASup30Index.h.

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

◆ getIndex() [2/2]

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

Get the index associated to a state.

Parameters
stateThe state to consider, as a string value.
Returns
The index associated to the state

Implements bpp::AlphabetIndex1.

Definition at line 96 of file AASEASup30Index.h.

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

◆ getIndexVector()

std::vector<double>* bpp::AASEASup30Index::getIndexVector ( ) const
inlinevirtual
Returns
A vector object with all indices.

Implements bpp::AlphabetIndex1.

Definition at line 101 of file AASEASup30Index.h.

References seaSup30_.

Member Data Documentation

◆ seaSup30_

std::vector<double> bpp::AASEASup30Index::seaSup30_
private

Definition at line 56 of file AASEASup30Index.h.

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


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