bpp::AASurfaceIndex Class Reference

Surface (Angström^2) of each amino acid, according to http://www.imb-jena.de/IMAGE_AA.html. More...

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

Inheritance diagram for bpp::AASurfaceIndex:

Collaboration diagram for bpp::AASurfaceIndex:

Public Member Functions
	AASurfaceIndex ()
virtual	~AASurfaceIndex ()
AASurfaceIndex *	clone () const override
double	getIndex (int state) const override
	Get the index associated to a state. More...
double	getIndex (const std::string &state) const override
	Get the index associated to a state. More...
const std::vector< double > &	indexVector () const override
std::shared_ptr< const Alphabet >	getAlphabet () const override
	Get the alphabet associated to this index. More...
const Alphabet &	alphabet () const override
	Get the alphabet associated to this index. More...

Private Attributes
std::vector< double >	surface_
std::shared_ptr< const ProteicAlphabet >	alpha_

Detailed Description

Surface (Angström^2) of each amino acid, according to http://www.imb-jena.de/IMAGE_AA.html.

Definition at line 19 of file AASurfaceIndex.h.

Constructor & Destructor Documentation

AASurfaceIndex()

bpp::AASurfaceIndex::AASurfaceIndex ( )

inline

Definition at line 26 of file AASurfaceIndex.h.

References surface_.

Referenced by clone().

~AASurfaceIndex()

virtual bpp::AASurfaceIndex::~AASurfaceIndex ( )

inlinevirtual

Definition at line 53 of file AASurfaceIndex.h.

Member Function Documentation

alphabet()

const Alphabet& bpp::ProteicAlphabetIndex1::alphabet ( ) const

inlineoverridevirtualinherited

Get the alphabet associated to this index.

Returns

Alphabet The alphabet associated to this index.

Implements bpp::AlphabetIndex1.

Definition at line 99 of file AlphabetIndex1.h.

References bpp::ProteicAlphabetIndex1::alpha_.

clone()

AASurfaceIndex* bpp::AASurfaceIndex::clone ( ) const

inlineoverridevirtual

Implements bpp::ProteicAlphabetIndex1.

Definition at line 55 of file AASurfaceIndex.h.

References AASurfaceIndex().

getAlphabet()

std::shared_ptr<const Alphabet> bpp::ProteicAlphabetIndex1::getAlphabet ( ) const

inlineoverridevirtualinherited

Get the alphabet associated to this index.

Returns

Alphabet The alphabet associated to this index.

Implements bpp::AlphabetIndex1.

Definition at line 97 of file AlphabetIndex1.h.

References bpp::ProteicAlphabetIndex1::alpha_.

Referenced by bpp::AAChargeIndex::getIndex(), bpp::AAChenGuHuangHydrophobicityIndex::getIndex(), bpp::AAChouFasmanAHelixIndex::getIndex(), bpp::AAChouFasmanBSheetIndex::getIndex(), bpp::AAChouFasmanTurnIndex::getIndex(), bpp::AAIndex1Entry::getIndex(), bpp::AAMassIndex::getIndex(), bpp::AASEA1030Index::getIndex(), bpp::AASEAInf10Index::getIndex(), bpp::AASEASup30Index::getIndex(), getIndex(), bpp::AAVolumeIndex::getIndex(), bpp::GranthamAAPolarityIndex::getIndex(), bpp::GranthamAAVolumeIndex::getIndex(), bpp::KD_AAHydropathyIndex::getIndex(), and bpp::KleinAANetChargeIndex::getIndex().

getIndex() [1/2]

double bpp::AASurfaceIndex::getIndex ( const std::string &  state ) const

inlineoverridevirtual

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 63 of file AASurfaceIndex.h.

References bpp::ProteicAlphabetIndex1::getAlphabet(), and surface_.

getIndex() [2/2]

double bpp::AASurfaceIndex::getIndex ( int  state ) const

inlineoverridevirtual

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 58 of file AASurfaceIndex.h.

References bpp::ProteicAlphabetIndex1::getAlphabet(), and surface_.

indexVector()

const std::vector<double>& bpp::AASurfaceIndex::indexVector ( ) const

inlineoverridevirtual

Returns

A vector object with all indices.

Implements bpp::AlphabetIndex1.

Definition at line 68 of file AASurfaceIndex.h.

References surface_.

Member Data Documentation

alpha_

std::shared_ptr<const ProteicAlphabet> bpp::ProteicAlphabetIndex1::alpha_

privateinherited

Definition at line 79 of file AlphabetIndex1.h.

Referenced by bpp::ProteicAlphabetIndex1::alphabet(), bpp::ProteicAlphabetIndex1::getAlphabet(), and bpp::ProteicAlphabetIndex1::operator=().

surface_

std::vector<double> bpp::AASurfaceIndex::surface_

private

Definition at line 23 of file AASurfaceIndex.h.

Referenced by AASurfaceIndex(), getIndex(), and indexVector().

---

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

• Bpp/Seq/AlphabetIndex/AASurfaceIndex.h