Transliterator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef BPP_SEQ_TRANSLITERATOR_H
#define BPP_SEQ_TRANSLITERATOR_H
 
 
#include "Alphabet/Alphabet.h"
#include "Sequence.h"
 
namespace bpp
{
class TransliteratorInterface
{
public:
  TransliteratorInterface() {}
  virtual ~TransliteratorInterface() {}
 
public:
  virtual std::shared_ptr<const Alphabet> getSourceAlphabet() const = 0;
 
  virtual const Alphabet& sourceAlphabet() const = 0;
 
  virtual std::shared_ptr<const Alphabet> getTargetAlphabet() const = 0;
 
  virtual const Alphabet& targetAlphabet() const = 0;
 
  virtual int translate(int state) const = 0;
 
  virtual std::string translate(const std::string& state) const = 0;
 
  virtual std::unique_ptr<Sequence> translate(const SequenceInterface& sequence) const = 0;
};
 
class ReverseTransliteratorInterface :
  public virtual TransliteratorInterface
{
public:
  ReverseTransliteratorInterface() {}
  virtual ~ReverseTransliteratorInterface() {}
 
public:
  virtual int reverse(int state) const = 0;
 
  virtual std::string reverse(const std::string& state) const = 0;
 
  virtual std::unique_ptr<Sequence> reverse(const SequenceInterface& sequence) const = 0;
};
 
class AbstractTransliterator :
  public virtual TransliteratorInterface
{
public:
  AbstractTransliterator() {}
  virtual ~AbstractTransliterator() {}
 
public:
  int translate(int state) const override = 0;
  std::string translate(const std::string& state) const override = 0;
 
  std::unique_ptr<Sequence> translate(const SequenceInterface& sequence) const override;
};
 
class AbstractReverseTransliterator :
  public virtual ReverseTransliteratorInterface,
  public AbstractTransliterator
{
public:
  AbstractReverseTransliterator() {}
  virtual ~AbstractReverseTransliterator() {}
 
public:
  int reverse(int state) const override = 0;
  std::string reverse(const std::string& state) const override = 0;
 
  std::unique_ptr<Sequence> reverse(const SequenceInterface& sequence) const override;
};
} // end of namespace bpp.
#endif // BPP_SEQ_TRANSLITERATOR_H