bpp-seq3  3.0.0
bpp::AAChouFasmanTurnIndex Class Reference

Turn score for the Chou-Fasman algorithm of secondary structure prediction, according to http://prowl.rockefeller.edu/aainfo/chou.htm. More...

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

+ Inheritance diagram for bpp::AAChouFasmanTurnIndex:
+ Collaboration diagram for bpp::AAChouFasmanTurnIndex:

Public Member Functions

 AAChouFasmanTurnIndex ()
 
virtual ~AAChouFasmanTurnIndex ()
 
AAChouFasmanTurnIndexclone () 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 AlphabetgetAlphabet () const override
 Get the alphabet associated to this index. More...
 
const Alphabetalphabet () const override
 Get the alphabet associated to this index. More...
 

Private Attributes

std::vector< double > turn_
 
std::shared_ptr< const ProteicAlphabetalpha_
 

Detailed Description

Turn score for the Chou-Fasman algorithm of secondary structure prediction, according to http://prowl.rockefeller.edu/aainfo/chou.htm.

Definition at line 18 of file AAChouFasmanTurnIndex.h.

Constructor & Destructor Documentation

◆ AAChouFasmanTurnIndex()

bpp::AAChouFasmanTurnIndex::AAChouFasmanTurnIndex ( )
inline

Definition at line 25 of file AAChouFasmanTurnIndex.h.

References turn_.

Referenced by clone().

◆ ~AAChouFasmanTurnIndex()

virtual bpp::AAChouFasmanTurnIndex::~AAChouFasmanTurnIndex ( )
inlinevirtual

Definition at line 52 of file AAChouFasmanTurnIndex.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()

AAChouFasmanTurnIndex* bpp::AAChouFasmanTurnIndex::clone ( ) const
inlineoverridevirtual

Implements bpp::ProteicAlphabetIndex1.

Definition at line 54 of file AAChouFasmanTurnIndex.h.

References AAChouFasmanTurnIndex().

◆ getAlphabet()

◆ getIndex() [1/2]

double bpp::AAChouFasmanTurnIndex::getIndex ( const std::string &  state) const
inlineoverridevirtual

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 65 of file AAChouFasmanTurnIndex.h.

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

◆ getIndex() [2/2]

double bpp::AAChouFasmanTurnIndex::getIndex ( int  state) const
inlineoverridevirtual

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 60 of file AAChouFasmanTurnIndex.h.

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

◆ indexVector()

const std::vector<double>& bpp::AAChouFasmanTurnIndex::indexVector ( ) const
inlineoverridevirtual
Returns
A vector object with all indices.

Implements bpp::AlphabetIndex1.

Definition at line 70 of file AAChouFasmanTurnIndex.h.

References turn_.

Member Data Documentation

◆ alpha_

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

◆ turn_

std::vector<double> bpp::AAChouFasmanTurnIndex::turn_
private

Definition at line 22 of file AAChouFasmanTurnIndex.h.

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


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