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::ReverseTransliteratorInterface:

Collaboration diagram for bpp::ReverseTransliteratorInterface:

Public Member Functions
	ReverseTransliteratorInterface ()

virtual	~ReverseTransliteratorInterface ()

virtual int	reverse (int state) const =0
	Translate a given state coded as a int from target alphabet to source alphabet. More...

virtual std::string	reverse (const std::string &state) const =0
	Translate a given state coded as a string from target alphabet to source alphabet. More...

virtual std::unique_ptr< Sequence >	reverse (const SequenceInterface &sequence) const =0
	Translate a whole sequence from target alphabet to source alphabet. More...

virtual std::shared_ptr< const Alphabet >	getSourceAlphabet () const =0
	Get the source alphabet. More...

virtual const Alphabet &	sourceAlphabet () const =0
	Get the source alphabet. More...

virtual std::shared_ptr< const Alphabet >	getTargetAlphabet () const =0
	Get the target alphabet. More...

virtual const Alphabet &	targetAlphabet () const =0
	Get the target alphabet. More...

virtual int	translate (int state) const =0
	Translate a given state coded as a int from source alphabet to target alphabet. More...

virtual std::string	translate (const std::string &state) const =0
	Translate a given state coded as a string from source alphabet to target alphabet. More...

virtual std::unique_ptr< Sequence >	translate (const SequenceInterface &sequence) const =0
	Translate a whole sequence from source alphabet to target alphabet. More...

Detailed Description

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

Definition at line 80 of file Transliterator.h.

Constructor & Destructor Documentation

◆ ReverseTransliteratorInterface()

bpp::ReverseTransliteratorInterface::ReverseTransliteratorInterface ( )

inline

Definition at line 84 of file Transliterator.h.

◆ ~ReverseTransliteratorInterface()

virtual bpp::ReverseTransliteratorInterface::~ReverseTransliteratorInterface ( )

inlinevirtual

Definition at line 85 of file Transliterator.h.

Member Function Documentation

◆ getSourceAlphabet()

virtual std::shared_ptr<const Alphabet> bpp::TransliteratorInterface::getSourceAlphabet ( ) const

pure virtualinherited

Get the source alphabet.

Returns: A pointer toward the source alphabet.

Implemented in bpp::NucleicAcidsReplication, bpp::GeneticCode, bpp::DNAToRNA, and bpp::AllelicAlphabet::AllelicTransliterator.

◆ getTargetAlphabet()

virtual std::shared_ptr<const Alphabet> bpp::TransliteratorInterface::getTargetAlphabet ( ) const

pure virtualinherited

Get the target alphabet.

Returns: A pointer toward the target alphabet.

Implemented in bpp::NucleicAcidsReplication, bpp::GeneticCode, bpp::DNAToRNA, and bpp::AllelicAlphabet::AllelicTransliterator.

◆ reverse() [1/3]

virtual std::unique_ptr<Sequence> bpp::ReverseTransliteratorInterface::reverse ( const SequenceInterface & sequence ) const

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.

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

◆ reverse() [2/3]

virtual std::string bpp::ReverseTransliteratorInterface::reverse ( const std::string & state ) const

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.

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

◆ reverse() [3/3]

virtual int bpp::ReverseTransliteratorInterface::reverse ( int state ) const

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.

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

◆ sourceAlphabet()

virtual const Alphabet& bpp::TransliteratorInterface::sourceAlphabet ( ) const

pure virtualinherited

Get the source alphabet.

Returns: A reference toward the source alphabet.

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

◆ targetAlphabet()

virtual const Alphabet& bpp::TransliteratorInterface::targetAlphabet ( ) const

pure virtualinherited

Get the target alphabet.

Returns: A reference toward the target alphabet.

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

◆ translate() [1/3]

virtual std::unique_ptr<Sequence> bpp::TransliteratorInterface::translate ( const SequenceInterface & sequence ) const

pure virtualinherited

Translate a whole sequence from source alphabet to target alphabet.

Parameters

sequence A sequence in source alphabet.

Returns: The corresponding sequence in target alphabet.

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

◆ translate() [2/3]

virtual std::string bpp::TransliteratorInterface::translate ( const std::string & state ) const

pure virtualinherited

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.

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

◆ translate() [3/3]

virtual int bpp::TransliteratorInterface::translate ( int state ) const

pure virtualinherited

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.

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

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

Bpp/Seq/Transliterator.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReverseTransliteratorInterface()

◆ ~ReverseTransliteratorInterface()

Member Function Documentation

◆ getSourceAlphabet()

◆ getTargetAlphabet()

◆ reverse() [1/3]

◆ reverse() [2/3]

◆ reverse() [3/3]

◆ sourceAlphabet()

◆ targetAlphabet()

◆ translate() [1/3]

◆ translate() [2/3]

◆ translate() [3/3]