SequencePositionIterators.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef BPP_SEQ_SEQUENCEPOSITIONITERATORS_H
#define BPP_SEQ_SEQUENCEPOSITIONITERATORS_H
 
 
// from STL
#include <string>
 
#include "Sequence.h"
 
namespace bpp
{
class SequencePositionIterator
{
public:
  SequencePositionIterator() {}
  virtual ~SequencePositionIterator() {}
 
public:
  virtual unsigned int getPosition() const = 0;
  virtual void setPosition(unsigned int pos) = 0;
  virtual int getValue() const = 0;
  virtual std::string getChar() const = 0;
 
  virtual bool operator==(const SequencePositionIterator& it) const = 0;
  virtual bool operator!=(const SequencePositionIterator& it) const = 0;
  virtual SequencePositionIterator& operator+=(int i) = 0;
  virtual SequencePositionIterator& operator-=(int i) = 0;
  virtual SequencePositionIterator& operator++() = 0;
 
  virtual bool hasMorePositions() const = 0;
  virtual const Sequence& getSequence() const = 0;
};
 
class AbstractSequencePositionIterator :
  public virtual SequencePositionIterator
{
private:
  const Sequence* sequence_;
  unsigned int currentPosition_;
 
public:
  AbstractSequencePositionIterator(const Sequence& seq, unsigned int pos = 0) :
    sequence_(&seq), currentPosition_(pos) {}
 
  AbstractSequencePositionIterator(const AbstractSequencePositionIterator& aspi) :
    sequence_(aspi.sequence_), currentPosition_(aspi.currentPosition_) {}
 
  AbstractSequencePositionIterator& operator=(const AbstractSequencePositionIterator& aspi)
  {
    sequence_ = aspi.sequence_;
    currentPosition_ = aspi.currentPosition_;
    return *this;
  }
 
  virtual ~AbstractSequencePositionIterator() {}
 
public:
  bool operator==(const SequencePositionIterator& it) const;
  bool operator!=(const SequencePositionIterator& it) const;
  unsigned int getPosition() const;
  void setPosition(unsigned int pos);
  int getValue() const;
  std::string getChar() const;
  const Sequence& getSequence() const;
};
 
class SimpleSequencePositionIterator :
  public AbstractSequencePositionIterator
{
public:
  SimpleSequencePositionIterator(const Sequence& seq, unsigned int pos = 0) :
    AbstractSequencePositionIterator(seq, pos) {}
  SimpleSequencePositionIterator(const SequencePositionIterator& it);
  virtual ~SimpleSequencePositionIterator() {}
public:
  SimpleSequencePositionIterator& operator++();
  virtual SimpleSequencePositionIterator operator++(int i);
  SimpleSequencePositionIterator& operator+=(int i);
  SimpleSequencePositionIterator& operator-=(int i);
  virtual SimpleSequencePositionIterator operator+(int i) const;
  virtual SimpleSequencePositionIterator operator-(int i) const;
  bool hasMorePositions() const;
};
}
#endif // BPP_SEQ_SEQUENCEPOSITIONITERATORS_H