bpp-seq-omics  2.4.1
Public Member Functions | Protected Attributes | List of all members
bpp::MafStatisticsResult Class Reference

General interface for storing statistical results. More...

#include <Bpp/Seq/Io/Maf/MafStatistics.h>

+ Inheritance diagram for bpp::MafStatisticsResult:
+ Collaboration diagram for bpp::MafStatisticsResult:

Public Member Functions

 MafStatisticsResult ()
 
virtual ~MafStatisticsResult ()
 
 MafStatisticsResult (const MafStatisticsResult &msr)
 
virtual const BppNumberI & getValue (const std::string &tag) const
 
virtual void setValue (const std::string &tag, double value)
 Associate a value to a certain tag. Any existing tag will be overwritten. More...
 
virtual void setValue (const std::string &tag, int value)
 Associate a value to a certain tag. Any existing tag will be overwritten. More...
 
virtual void setValue (const std::string &tag, unsigned int value)
 Associate a value to a certain tag. Any existing tag will be overwritten. More...
 
virtual bool hasValue (const std::string &tag) const
 
std::vector< std::string > getAvailableTags () const
 

Protected Attributes

std::map< std::string, BppNumberI * > values_
 

Detailed Description

General interface for storing statistical results.

Author
Julien Dutheil
See also
MafStatistics

Definition at line 62 of file MafStatistics.h.

Constructor & Destructor Documentation

◆ MafStatisticsResult() [1/2]

bpp::MafStatisticsResult::MafStatisticsResult ( )
inline

Definition at line 68 of file MafStatistics.h.

◆ ~MafStatisticsResult()

virtual bpp::MafStatisticsResult::~MafStatisticsResult ( )
inlinevirtual

Definition at line 69 of file MafStatistics.h.

◆ MafStatisticsResult() [2/2]

bpp::MafStatisticsResult::MafStatisticsResult ( const MafStatisticsResult &  msr)
inline

Definition at line 71 of file MafStatistics.h.

References values_.

Member Function Documentation

◆ getAvailableTags()

std::vector<std::string> bpp::MafStatisticsResult::getAvailableTags ( ) const
inline
Returns
A vector with all available tags.

Definition at line 139 of file MafStatistics.h.

References bpp::MapTools::getKeys(), and values_.

Referenced by bpp::AbstractMafStatisticsSimple::getSupportedTags().

◆ getValue()

virtual const BppNumberI& bpp::MafStatisticsResult::getValue ( const std::string &  tag) const
inlinevirtual

Reimplemented in bpp::SimpleMafStatisticsResult.

Definition at line 81 of file MafStatistics.h.

References values_.

Referenced by bpp::SequenceStatisticsMafIterator::analyseCurrentBlock_(), and bpp::SimpleMafStatisticsResult::getValue().

◆ hasValue()

virtual bool bpp::MafStatisticsResult::hasValue ( const std::string &  tag) const
inlinevirtual
Returns
A boolean saying whether a value is available for the given tag.
Parameters
tagThe name of the value to associate.

Definition at line 132 of file MafStatistics.h.

References values_.

Referenced by bpp::SequenceStatisticsMafIterator::analyseCurrentBlock_().

◆ setValue() [1/3]

virtual void bpp::MafStatisticsResult::setValue ( const std::string &  tag,
double  value 
)
inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters
tagThe name of the value to associate.
valueThe value to associate to the tag.

Reimplemented in bpp::SimpleMafStatisticsResult.

Definition at line 95 of file MafStatistics.h.

References values_.

Referenced by bpp::CharacterCountsMafStatistics::compute(), bpp::SiteFrequencySpectrumMafStatistics::compute(), bpp::FourSpeciesPatternCountsMafStatistics::compute(), bpp::SiteMafStatistics::compute(), bpp::PolymorphismMafStatistics::compute(), and bpp::SequenceDiversityMafStatistics::compute().

◆ setValue() [2/3]

virtual void bpp::MafStatisticsResult::setValue ( const std::string &  tag,
int  value 
)
inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters
tagThe name of the value to associate.
valueThe value to associate to the tag.

Reimplemented in bpp::SimpleMafStatisticsResult.

Definition at line 108 of file MafStatistics.h.

References values_.

◆ setValue() [3/3]

virtual void bpp::MafStatisticsResult::setValue ( const std::string &  tag,
unsigned int  value 
)
inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters
tagThe name of the value to associate.
valueThe value to associate to the tag.

Reimplemented in bpp::SimpleMafStatisticsResult.

Definition at line 121 of file MafStatistics.h.

References values_.

Member Data Documentation

◆ values_

std::map<std::string, BppNumberI*> bpp::MafStatisticsResult::values_
mutableprotected

Definition at line 65 of file MafStatistics.h.

Referenced by getAvailableTags(), bpp::SimpleMafStatisticsResult::getValue(), getValue(), hasValue(), MafStatisticsResult(), setValue(), and bpp::SimpleMafStatisticsResult::setValue().

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