bpp::ProbabilisticSymbolListInterface Class Reference

The ProbabilisticSymbolList interface. More...

#include <Bpp/Seq/ProbabilisticSymbolList.h>

Inheritance diagram for bpp::ProbabilisticSymbolListInterface:

Collaboration diagram for bpp::ProbabilisticSymbolListInterface:

Public Types
typedef std::vector< double >	SymbolType
typedef Table< double >	DTable

Public Member Functions
	ProbabilisticSymbolListInterface ()
virtual	~ProbabilisticSymbolListInterface ()
virtual const DTable &	getTable () const =0
virtual void	setContent (const DTable &list)=0
virtual void	setContent (const std::vector< T > &list)=0
	Set the whole content of the list. More...
virtual std::shared_ptr< const Alphabet >	getAlphabet () const =0
	Get the alphabet associated to the list. More...
virtual const Alphabet &	alphabet () const =0
	Get the alphabet associated to the list. More...
virtual size_t	size () const =0
	Get the number of elements in the list. More...
virtual std::string	toString () const =0
	Convert the list as a string. More...
virtual double	getStateValueAt (size_t position, int state) const =0
	get value of a state at a position More...
virtual double	operator() (size_t position, int state) const =0
	get value of a state at a position More...
The Clonable interface
TemplateCoreSymbolListInterface *	clone () const override=0
Acting on the content of the list.
virtual void	setContent (const std::vector< T > &list)=0
	Set the whole content of the list. More...
virtual const std::vector< T > &	getContent () const =0
Edition methods.
virtual void	addElement (const T &c)=0
	Add a character to the end of the list. More...
virtual void	addElement (size_t pos, const T &c)=0
	Add a character at a certain position in the list. More...
virtual void	setElement (size_t pos, const T &c)=0
	Set the element at position 'pos' to character 'c'. More...
virtual const T &	getElement (size_t pos) const =0
	Get the element at position 'pos' as a character. More...
Provide direct access to the list content.
Warning These operators allow you to modify the list content. No alphabet checking is performed for your modifications, so use with care, or consider using the setContent() method.
virtual const T &	getValue (size_t pos) const =0
	checked access to a character in list. More...
virtual const T &	operator[] (size_t pos) const =0
	Operator [] overloaded for quick access to a character in list. More...
virtual T &	operator[] (size_t pos)=0
	Operator [] overloaded for quick access to a character in list. More...
Edition methods.
virtual void	deleteElement (size_t pos)=0
	Remove the element at position 'pos'. More...
virtual void	deleteElements (size_t pos, size_t len)=0
	Remove the elements at position 'pos'. More...
Provide direct access to the list content.
Warning These operators allow you to modify the list content. No alphabet checking is performed for your modifications, so use with care, or consider using the setContent() method.
virtual void	shuffle ()=0
	Randomly shuffle the content of the list, with linear complexity. More...

Detailed Description

The ProbabilisticSymbolList interface.

This container aims at containing an ordered list of probabilistic sites. It does not inherit from * SympbolList<std::vector<double>> because it does not contain a * vector of sites but a Table of doubles.

Definition at line 30 of file ProbabilisticSymbolList.h.

Member Typedef Documentation

DTable

typedef Table<double> bpp::ProbabilisticSymbolListInterface::DTable

Definition at line 35 of file ProbabilisticSymbolList.h.

SymbolType

typedef std::vector<double> bpp::ProbabilisticSymbolListInterface::SymbolType

Definition at line 34 of file ProbabilisticSymbolList.h.

Constructor & Destructor Documentation

ProbabilisticSymbolListInterface()

bpp::ProbabilisticSymbolListInterface::ProbabilisticSymbolListInterface ( )

inline

Definition at line 38 of file ProbabilisticSymbolList.h.

~ProbabilisticSymbolListInterface()

virtual bpp::ProbabilisticSymbolListInterface::~ProbabilisticSymbolListInterface ( )

inlinevirtual

Definition at line 41 of file ProbabilisticSymbolList.h.

Member Function Documentation

addElement() [1/2]

template<class T >

virtual void bpp::TemplateCoreSymbolListInterface< T >::addElement ( const T &  c )

pure virtualinherited

Add a character to the end of the list.

Parameters

c	The character to add.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, and bpp::AbstractTemplateSymbolList< T >.

addElement() [2/2]

template<class T >

virtual void bpp::TemplateCoreSymbolListInterface< T >::addElement ( size_t  pos, const T &  c  )

pure virtualinherited

Add a character at a certain position in the list.

Parameters

pos	The position where to insert the element.
c	The character to add.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, and bpp::AbstractTemplateSymbolList< T >.

alphabet()

virtual const Alphabet& bpp::CruxSymbolListInterface::alphabet ( ) const

pure virtualinherited

Get the alphabet associated to the list.

Returns

A const reference to the alphabet.

See also

Alphabet class.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::SequenceTools::combineSequences(), bpp::SequenceTools::complement(), bpp::SequenceTools::concatenate(), bpp::GeneticCode::getCodingSequence(), bpp::SequenceTools::getComplement(), bpp::SequenceTools::getNumberOfCompleteSites(), bpp::SequenceTools::getNumberOfSites(), bpp::SequenceTools::getPercentIdentity(), bpp::SequenceTools::getSequenceWithCompleteSites(), bpp::SequenceTools::invertComplement(), bpp::AbstractReverseTransliterator::reverse(), bpp::SequenceTools::RNYslice(), and bpp::AbstractTransliterator::translate().

clone()

template<class T >

TemplateCoreSymbolListInterface* bpp::TemplateCoreSymbolListInterface< T >::clone ( ) const

overridepure virtualinherited

Implements bpp::CruxSymbolListInterface.

Implemented in bpp::SiteInterface, bpp::SequenceInterface, bpp::TemplateEventDrivenCoreSymbolListInterface< T >, bpp::SequenceWithQuality, bpp::SequenceWithAnnotation, bpp::Sequence, bpp::ProbabilisticSymbolList, bpp::ProbabilisticSequence, bpp::EventDrivenIntSymbolList, bpp::IntSymbolList, bpp::ProbabilisticSiteInterface, bpp::ProbabilisticSequenceInterface, bpp::Site, and bpp::ProbabilisticSite.

deleteElement()

virtual void bpp::CruxSymbolListInterface::deleteElement ( size_t  pos )

pure virtualinherited

Remove the element at position 'pos'.

Parameters

pos	The position of the element to remove.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, bpp::AbstractTemplateEventDrivenSymbolList< int >, bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::SequenceTools::getCDS(), bpp::SequenceTools::removeGaps(), and bpp::SequenceTools::removeStops().

deleteElements()

virtual void bpp::CruxSymbolListInterface::deleteElements ( size_t  pos, size_t  len  )

pure virtualinherited

Remove the elements at position 'pos'.

Parameters

pos	The position of the first element to remove.
len	The length of the region to remove.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, bpp::AbstractTemplateEventDrivenSymbolList< int >, bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

getAlphabet()

virtual std::shared_ptr<const Alphabet> bpp::CruxSymbolListInterface::getAlphabet ( ) const

pure virtualinherited

Get the alphabet associated to the list.

Returns

A const pointer to the alphabet.

See also

Alphabet class.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::Sequence::append(), bpp::SequenceWithAnnotation::append(), bpp::SequenceTools::areSequencesIdentical(), bpp::SymbolListTools::areSymbolListsIdentical(), bpp::SequenceTools::bowkerTest(), bpp::SymbolListTools::changeGapsToUnknownCharacters(), bpp::SymbolListTools::changeUnresolvedCharactersToGaps(), bpp::SequenceTools::combineSequences(), bpp::SequenceWithQualityTools::complement(), bpp::SequenceTools::complement(), bpp::SiteContainerTools::computeSimilarity(), bpp::SequenceTools::concatenate(), bpp::SequenceWithQualityTools::concatenate(), bpp::SequenceTools::findFirstOf(), bpp::SequenceTools::getCDS(), bpp::SequenceTools::getComplement(), bpp::SymbolListTools::getCountsResolveUnknowns(), bpp::SymbolListTools::getGCContent(), bpp::SymbolListTools::getNumberOfDistinctPositions(), bpp::SymbolListTools::getNumberOfPositionsWithoutGap(), bpp::SequenceTools::getNumberOfUnresolvedSites(), bpp::SequenceTools::getPercentIdentity(), bpp::SequenceTools::getPutativeHaplotypes(), bpp::SequenceTools::getSequenceWithoutGaps(), bpp::SequenceTools::getSequenceWithoutStops(), bpp::SymbolListTools::hasGap(), bpp::SymbolListTools::hasUnknown(), bpp::SymbolListTools::hasUnresolved(), bpp::SequenceTools::invertComplement(), bpp::SymbolListTools::isComplete(), bpp::SymbolListTools::isConstant(), bpp::SymbolListTools::isGapOnly(), bpp::SymbolListTools::isGapOrUnresolvedOnly(), bpp::SymbolListTools::jointEntropy(), bpp::SequenceWithAnnotation::merge(), bpp::SymbolListTools::mutualInformation(), bpp::SymbolListTools::numberOfGaps(), bpp::SymbolListTools::numberOfUnresolved(), bpp::ProbabilisticSymbolList::operator=(), bpp::AbstractTemplateSymbolList< T >::operator=(), bpp::SequenceWithQualityTools::removeGaps(), bpp::SequenceTools::removeGaps(), bpp::SequenceTools::removeStops(), bpp::SequenceTools::replaceStopsWithGaps(), bpp::WordAlphabet::reverse(), bpp::NucleicAcidsReplication::reverse(), bpp::SequenceWithQualityTools::reverseTranscript(), bpp::SequenceTools::RNYslice(), bpp::SequenceTools::subseq(), bpp::SequenceWithQualityTools::subseq(), bpp::SequenceTools::subtractHaplotype(), bpp::SequenceWithQualityTools::transcript(), bpp::NucleicAcidsReplication::translate(), bpp::AbstractTransliterator::translate(), bpp::WordAlphabet::translate(), and bpp::SymbolListTools::variabilityShannon().

getContent()

template<class T >

virtual const std::vector<T>& bpp::TemplateCoreSymbolListInterface< T >::getContent ( ) const

pure virtualinherited

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::Sequence::append(), bpp::SequenceWithQualityTools::concatenate(), bpp::SequenceWithQualityTools::invert(), bpp::SequenceWithAnnotation::merge(), bpp::ProbabilisticSymbolList::operator=(), and bpp::Sequence::operator=().

getElement()

template<class T >

virtual const T& bpp::TemplateCoreSymbolListInterface< T >::getElement ( size_t  pos ) const

pure virtualinherited

Get the element at position 'pos' as a character.

Parameters

pos	The position of the character to retrieve.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

getStateValueAt()

virtual double bpp::CruxSymbolListInterface::getStateValueAt ( size_t  position, int  state  ) const

pure virtualinherited

get value of a state at a position

Parameters

position	position in the list
state	state in the alphabet

Returns

The state value at the given position.

Implemented in bpp::Sequence, bpp::ProbabilisticSequence, bpp::ProbabilisticSymbolList, bpp::IntSymbolList, bpp::CoreSiteInterface, bpp::Site, and bpp::ProbabilisticSite.

Referenced by bpp::ProbabilisticSymbolList::ProbabilisticSymbolList().

getTable()

virtual const DTable& bpp::ProbabilisticSymbolListInterface::getTable ( ) const

pure virtual

Implemented in bpp::ProbabilisticSymbolList.

getValue()

template<class T >

virtual const T& bpp::TemplateCoreSymbolListInterface< T >::getValue ( size_t  pos ) const

pure virtualinherited

checked access to a character in list.

Parameters

pos	The position to retrieve.

Returns

The T value of character at position pos.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::SequenceTools::combineSequences(), bpp::SequenceTools::complement(), bpp::SequenceTools::findFirstOf(), bpp::SymbolListTools::getGCContent(), bpp::SequenceTools::getPercentIdentity(), bpp::SequenceTools::invert(), bpp::SequenceTools::invertComplement(), bpp::NucleicAcidsReplication::reverse(), bpp::AbstractReverseTransliterator::reverse(), bpp::SequenceTools::subtractHaplotype(), bpp::NucleicAcidsReplication::translate(), and bpp::AbstractTransliterator::translate().

operator()()

virtual double bpp::CruxSymbolListInterface::operator() ( size_t  position, int  state  ) const

pure virtualinherited

get value of a state at a position

Short-cut for getStateValueAt.

Parameters

position	position in the list
state	state in the alphabet

Returns

The state value at the given position.

Implemented in bpp::ProbabilisticSymbolList, and bpp::IntSymbolList.

operator[]() [1/2]

template<class T >

virtual const T& bpp::TemplateCoreSymbolListInterface< T >::operator[] ( size_t  pos ) const

pure virtualinherited

Operator [] overloaded for quick access to a character in list.

Parameters

pos	The position to retrieve.

Returns

The T value of character at position pos.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

operator[]() [2/2]

template<class T >

virtual T& bpp::TemplateCoreSymbolListInterface< T >::operator[] ( size_t  pos )

pure virtualinherited

Operator [] overloaded for quick access to a character in list.

Parameters

pos	The position to retrieve.

Returns

The T value of character at position pos.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

setContent() [1/3]

virtual void bpp::ProbabilisticSymbolListInterface::setContent ( const DTable &  list )

pure virtual

Implemented in bpp::ProbabilisticSymbolList.

setContent() [2/3]

template<class T >

virtual void bpp::TemplateCoreSymbolListInterface< T >::setContent ( const std::vector< T > &  list )

pure virtualinherited

Set the whole content of the list.

Parameters

list	The new content of the list.

See also

The list constructor for information about the way lists are internally stored.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, and bpp::AbstractTemplateSymbolList< T >.

setContent() [3/3]

virtual void bpp::TemplateCoreSymbolListInterface< T >::setContent

Set the whole content of the list.

Parameters

list	The new content of the list.

See also

The list constructor for information about the way lists are internally stored.

Referenced by bpp::ProbabilisticSymbolList::operator=(), and bpp::ProbabilisticSymbolList::ProbabilisticSymbolList().

setElement()

template<class T >

virtual void bpp::TemplateCoreSymbolListInterface< T >::setElement ( size_t  pos, const T &  c  )

pure virtualinherited

Set the element at position 'pos' to character 'c'.

Parameters

pos	The position of the character to set.
c	The value of the element.

Implemented in bpp::AbstractTemplateEventDrivenSymbolList< T >, and bpp::AbstractTemplateSymbolList< T >.

shuffle()

virtual void bpp::CruxSymbolListInterface::shuffle ( )

pure virtualinherited

Randomly shuffle the content of the list, with linear complexity.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

size()

virtual size_t bpp::CruxSymbolListInterface::size ( ) const

pure virtualinherited

Get the number of elements in the list.

Returns

The number of sites in the list.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, and bpp::ProbabilisticSymbolList.

Referenced by bpp::AbstractTemplateSymbolList< T >::AbstractTemplateSymbolList(), bpp::SequenceWithQuality::addElement(), bpp::SequenceWithAnnotation::append(), bpp::SequenceTools::areSequencesIdentical(), bpp::SymbolListTools::areSymbolListsIdentical(), bpp::SequenceTools::bowkerTest(), bpp::SymbolListTools::changeGapsToUnknownCharacters(), bpp::SymbolListTools::changeUnresolvedCharactersToGaps(), bpp::SequenceTools::combineSequences(), bpp::SequenceTools::complement(), bpp::SiteContainerTools::computeSimilarity(), bpp::SequenceTools::concatenate(), bpp::SequenceTools::findFirstOf(), bpp::SequenceTools::getCDS(), bpp::GeneticCode::getCodingSequence(), bpp::SymbolListTools::getCounts(), bpp::SymbolListTools::getCountsResolveUnknowns(), bpp::SymbolListTools::getFrequencies(), bpp::SymbolListTools::getGCContent(), bpp::SymbolListTools::getMajorAllele(), bpp::SymbolListTools::getMajorAlleleFrequency(), bpp::SymbolListTools::getMinorAllele(), bpp::SymbolListTools::getMinorAlleleFrequency(), bpp::SequenceTools::getNumberOfCompleteSites(), bpp::SymbolListTools::getNumberOfDistinctCharacters(), bpp::SymbolListTools::getNumberOfDistinctPositions(), bpp::SymbolListTools::getNumberOfPositionsWithoutGap(), bpp::SequenceTools::getNumberOfSites(), bpp::SequenceTools::getNumberOfUnresolvedSites(), bpp::SequenceTools::getPercentIdentity(), bpp::SequenceTools::getPutativeHaplotypes(), bpp::SequenceTools::getSequenceWithCompleteSites(), bpp::SequenceTools::getSequenceWithoutGaps(), bpp::SequenceTools::getSequenceWithoutStops(), bpp::SymbolListTools::hasGap(), bpp::SymbolListTools::hasSingleton(), bpp::SymbolListTools::hasUnknown(), bpp::SymbolListTools::hasUnresolved(), bpp::SymbolListTools::heterozygosity(), bpp::SequenceTools::invert(), bpp::SequenceTools::invertComplement(), bpp::SymbolListTools::isComplete(), bpp::SymbolListTools::isConstant(), bpp::SymbolListTools::isDoubleton(), bpp::SymbolListTools::isGapOnly(), bpp::SymbolListTools::isGapOrUnresolvedOnly(), bpp::SymbolListTools::isParsimonyInformativeSite(), bpp::SymbolListTools::isTriplet(), bpp::SequenceMask::isValidWith(), bpp::SequenceQuality::isValidWith(), bpp::SymbolListTools::jointEntropy(), bpp::SymbolListTools::mutualInformation(), bpp::SymbolListTools::numberOfGaps(), bpp::SymbolListTools::numberOfUnresolved(), bpp::AbstractTemplateSymbolList< T >::operator=(), bpp::SiteInterface::operator==(), bpp::SequenceWithQualityTools::removeGaps(), bpp::SequenceTools::removeGaps(), bpp::SequenceTools::removeStops(), bpp::SequenceTools::replaceStopsWithGaps(), bpp::CodonAlphabet::reverse(), bpp::WordAlphabet::reverse(), bpp::NucleicAcidsReplication::reverse(), bpp::AbstractReverseTransliterator::reverse(), bpp::SequenceTools::RNYslice(), bpp::SequenceWalker::SequenceWalker(), bpp::SequenceTools::subseq(), bpp::SequenceWithQualityTools::subseq(), bpp::SequenceTools::subtractHaplotype(), bpp::NucleicAcidsReplication::translate(), bpp::AbstractTransliterator::translate(), bpp::CodonAlphabet::translate(), bpp::WordAlphabet::translate(), bpp::SymbolListTools::variabilityFactorial(), and bpp::SymbolListTools::variabilityShannon().

toString()

virtual std::string bpp::CruxSymbolListInterface::toString ( ) const

pure virtualinherited

Convert the list as a string.

This method is useful for dumping a list to a file or to the screen for display.

Returns

The whole list as a string.

Implemented in bpp::AbstractTemplateSymbolList< T >, bpp::AbstractTemplateSymbolList< int >, bpp::Sequence, bpp::ProbabilisticSymbolList, bpp::EventDrivenIntSymbolList, and bpp::IntSymbolList.

---

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

• Bpp/Seq/ProbabilisticSymbolList.h