yat  0.21pre
Public Types | Public Member Functions | Friends | Related Functions | List of all members
theplu::yat::omic::Fasta::Sequence Class Reference

#include <yat/omic/Fasta.h>

Public Types

typedef const char * const_iterator
 const iterator is a const char*
 

Public Member Functions

const_iterator begin (void) const
 
const_iterator end (void) const
 
int size (void) const
 
char operator[] (size_t i) const
 

Friends

class Fasta
 
Sequence reverse_complement (const Fasta::Sequence &)
 

Related Functions

(Note that these are not member functions.)

Fasta::Sequence reverse_complement (const Fasta::Sequence &sequence)
 
std::ostream & operator<< (std::ostream &os, const Fasta::Sequence &)
 outpout operator for Fasta:Sequence More...
 

Detailed Description

Class holding sequence fetch from fasta file.

Class is const and its copy and assignment are shallow, i.e., they only copy pointers to the underlying data and do not alter the underlying data.

Class is typically constructed in functions Fasta::sequence.

Member Function Documentation

◆ begin()

const_iterator theplu::yat::omic::Fasta::Sequence::begin ( void  ) const
Returns
iterator to first element

◆ end()

const_iterator theplu::yat::omic::Fasta::Sequence::end ( void  ) const
Returns
iterator to one-passed last element

◆ operator[]()

char theplu::yat::omic::Fasta::Sequence::operator[] ( size_t  i) const
Returns
ith element

◆ size()

int theplu::yat::omic::Fasta::Sequence::size ( void  ) const
Returns
number of elements contained in sequence

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  os,
const Fasta::Sequence  
)
related

outpout operator for Fasta:Sequence

Since
New in yat 0.16

◆ reverse_complement()

Fasta::Sequence reverse_complement ( const Fasta::Sequence sequence)
related

Create a new Sequence that reflects the reverse complement of sequence.

See also
dna_reverse_complement

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

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14