bpp::ReverseTransliterator Class Reference

The same as previous, but can perform the reverse translation, eg: RNA -> DNA and DNA -> RNA;. More...

#include <Bpp/Seq/Transliterator.h>

Inheritance diagram for bpp::ReverseTransliterator:

Collaboration diagram for bpp::ReverseTransliterator:

List of all members.

Public Member Functions
	ReverseTransliterator ()
virtual	~ReverseTransliterator ()
virtual int	reverse (int state) const =0 throw (BadIntException, Exception)
	Translate a given state coded as a int from target alphabet to source alphabet.
virtual std::string	reverse (const std::string &state) const =0 throw (BadCharException, Exception)
	Translate a given state coded as a string from target alphabet to source alphabet.
virtual Sequence *	reverse (const Sequence &sequence) const =0 throw (AlphabetMismatchException, Exception)
	Translate a whole sequence from target alphabet to source alphabet.
virtual const Alphabet *	getSourceAlphabet () const =0
	Get the source alphabet.
virtual const Alphabet *	getTargetAlphabet () const =0
	Get the target alphabet.
virtual int	translate (int state) const =0 throw (BadIntException, Exception)
	Translate a given state coded as a int from source alphabet to target alphabet.
virtual std::string	translate (const std::string &state) const =0 throw (BadCharException, Exception)
	Translate a given state coded as a string from source alphabet to target alphabet.
virtual Sequence *	translate (const Sequence &sequence) const =0 throw (AlphabetMismatchException, Exception)
	Translate a whole sequence from source alphabet to target alphabet.

---

Detailed Description

The same as previous, but can perform the reverse translation, eg: RNA -> DNA and DNA -> RNA;.

Definition at line 108 of file Transliterator.h.

---

Constructor & Destructor Documentation

bpp::ReverseTransliterator::ReverseTransliterator

(

)

[inline]

Definition at line 112 of file Transliterator.h.

virtual bpp::ReverseTransliterator::~ReverseTransliterator

(

)

[inline, virtual]

Definition at line 113 of file Transliterator.h.

---

Member Function Documentation

virtual const Alphabet* bpp::Transliterator::getSourceAlphabet

(

)

const [pure virtual, inherited]

Get the source alphabet.

Returns:

The source alphabet.

Implemented in bpp::AbstractReverseTransliterator, bpp::GeneticCode, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual const Alphabet* bpp::Transliterator::getTargetAlphabet

(

)

const [pure virtual, inherited]

Get the target alphabet.

Returns:

The target alphabet.

Implemented in bpp::AbstractReverseTransliterator, bpp::GeneticCode, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual int bpp::ReverseTransliterator::reverse

(

int

state

)

const throw (BadIntException, Exception) [pure virtual]

Translate a given state coded as a int from target alphabet to source alphabet.

Parameters:

state

A state in target alphabet.

Returns:

The corresponding state in source alphabet.

Exceptions:

BadIntException	If the state is not a proper state for target alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractReverseTransliterator, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual std::string bpp::ReverseTransliterator::reverse

(

const std::string &

state

)

const throw (BadCharException, Exception) [pure virtual]

Translate a given state coded as a string from target alphabet to source alphabet.

Parameters:

state

A state in target alphabet.

Returns:

The corresponding state in source alphabet.

Exceptions:

BadCharException	If the state is not a proper state for target alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractReverseTransliterator, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual Sequence* bpp::ReverseTransliterator::reverse

(

const Sequence &

sequence

)

const throw (AlphabetMismatchException, Exception) [pure virtual]

Translate a whole sequence from target alphabet to source alphabet.

Parameters:

sequence

A sequence in target alphabet.

Returns:

The corresponding sequence in source alphabet.

Exceptions:

AlphabetMismatchException	If the sequence alphabet do not match the target alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractReverseTransliterator, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual int bpp::Transliterator::translate

(

int

state

)

const throw (BadIntException, Exception) [pure virtual, inherited]

Translate a given state coded as a int from source alphabet to target alphabet.

Parameters:

state

A state in source alphabet.

Returns:

The corresponding state in target alphabet.

Exceptions:

BadIntException	If the state is not a proper state for source alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractTransliterator, bpp::GeneticCode, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual std::string bpp::Transliterator::translate

(

const std::string &

state

)

const throw (BadCharException, Exception) [pure virtual, inherited]

Translate a given state coded as a string from source alphabet to target alphabet.

Parameters:

state

A state in source alphabet.

Returns:

The corresponding state in target alphabet.

Exceptions:

BadCharException	If the state is not a proper state for source alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractTransliterator, bpp::GeneticCode, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

virtual Sequence* bpp::Transliterator::translate

(

const Sequence &

sequence

)

const throw (AlphabetMismatchException, Exception) [pure virtual, inherited]

Translate a whole sequence from source alphabet to target alphabet.

Parameters:

sequence

A sequence in source alphabet.

Returns:

The corresponding sequence in target alphabet.

Exceptions:

AlphabetMismatchException	If the sequence alphabet do not match the source alphabet.
Exception	Other kind of error, depending on the implementation.

Implemented in bpp::AbstractTransliterator, bpp::GeneticCode, bpp::NucleicAcidsReplication, and bpp::DNAToRNA.

---

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

• Bpp/Seq/Transliterator.h