libsequence  1.9.5
Sequence::phylipData< T > Class Template Reference

#include <phylipData.hpp>

Inheritance diagram for Sequence::phylipData< T >:
Sequence::AlignStream< T >

Public Types

typedef std::vector< T >::size_type size_type
 
typedef std::vector< T >::reference reference
 
typedef std::vector< T >::const_reference const_reference
 
typedef std::vector< T >::iterator iterator
 
typedef std::vector< T >::const_iterator const_iterator
 

Public Member Functions

 phylipData (const std::vector< T > &_data)
 
 phylipData (const AlignStream< T > &a)
 
 phylipData (const phylipData< T > &a)
 
 phylipData (AlignStream< T > &&a)
 
 phylipData (phylipData< T > &&a)
 
 phylipData (std::vector< T > &&a)
 
std::istream & read (std::istream &s)
 
std::ostream & print (std::ostream &s) const
 
phylipData< T > & operator= (const AlignStream< T > &rhs)
 
bool empty () const
 
size_type size (void) const
 
reference operator[] (const size_type &i)
 
const_reference operator[] (const size_type &i) const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
bool IsAlignment (void)
 
bool Gapped (void)
 
unsigned UnGappedLength (void)
 
void RemoveGaps (void)
 
void RemoveTerminalGaps (void)
 
std::vector< T > Trim (std::vector< int >sites)
 
std::vector< T > TrimComplement (std::vector< int >sites)
 
const std::vector< T > Data (void)
 
void assign (const_iterator beg, const_iterator end)
 
void assign (std::vector< T > &&_data)
 

Detailed Description

template<typename T>
class Sequence::phylipData< T >

Input of phylip-format alignments

Definition at line 36 of file phylipData.hpp.

Member Typedef Documentation

◆ const_iterator

template<typename T>
typedef std::vector<T>::const_iterator Sequence::AlignStream< T >::const_iterator
inherited

value type is std::vector<T>::const_iterator

Definition at line 124 of file AlignStream.hpp.

◆ iterator

template<typename T>
typedef std::vector<T>::iterator Sequence::AlignStream< T >::iterator
inherited

value type is std::vector<T>::iterator

Definition at line 120 of file AlignStream.hpp.

Member Function Documentation

◆ assign() [1/2]

template<typename T>
void Sequence::AlignStream< T >::assign ( const_iterator  beg,
const_iterator  end 
)
inherited

Assign data to object. Since the value type for these iterators evaluates to std::vector<T>::const_iterator, any vector<T> can be the data source

Exceptions
std::runtime_erroris thrown if all data elements in the range (beg,end] are not of the same length

◆ assign() [2/2]

template<typename T>
void Sequence::AlignStream< T >::assign ( std::vector< T > &&  _data)
inherited

Assign via a move operation

Exceptions
std::runtime_erroris thrown if all data elements are not of the same length

◆ empty()

template<typename T>
bool Sequence::AlignStream< T >::empty ( ) const
inlineinherited

Returns data.empty()

Definition at line 85 of file AlignStream.hpp.

◆ operator[]() [1/2]

template<typename T>
reference Sequence::AlignStream< T >::operator[] ( const size_type &  i)
inlineinherited

Returns the i-th object of type T in the vector data

Definition at line 101 of file AlignStream.hpp.

◆ operator[]() [2/2]

template<typename T>
const_reference Sequence::AlignStream< T >::operator[] ( const size_type &  i) const
inlineinherited

Returns the i-th object of type T in the vector data

Definition at line 109 of file AlignStream.hpp.

◆ print()

template<typename T>
std::ostream& Sequence::phylipData< T >::print ( std::ostream &  s) const
virtual

To define a non-abstract AlignStream, print must be defined

Implements Sequence::AlignStream< T >.

◆ read()

template<typename T>
std::istream& Sequence::phylipData< T >::read ( std::istream &  s)
virtual

To define a non-abstract AlignStream, read must be defined

Implements Sequence::AlignStream< T >.

◆ size()

template<typename T>
size_type Sequence::AlignStream< T >::size ( void  ) const
inlineinherited

Returns data.size()

Definition at line 93 of file AlignStream.hpp.


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