OrderedValuesContainer.h

Go to the documentation of this file.

//
// File: OrderedValuesContainer.h
// Authors:
//   Laurent Guéguen
//
 
/*
  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
  
  This software is a computer program whose purpose is to provide classes
  for sequences analysis.
  
  This software is governed by the CeCILL license under French law and
  abiding by the rules of distribution of free software. You can use,
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info".
  
  As a counterpart to the access to the source code and rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty and the software's author, the holder of the
  economic rights, and the successive licensors have only limited
  liability.
  
  In this respect, the user's attention is drawn to the risks associated
  with loading, using, modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean that it is complicated to manipulate, and that also
  therefore means that it is reserved for developers and experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or
  data to be ensured and, more generally, to use and operate it in the
  same conditions as regards security.
  
  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/
 
#ifndef BPP_SEQ_CONTAINER_ORDEREDVALUESCONTAINER_H
#define BPP_SEQ_CONTAINER_ORDEREDVALUESCONTAINER_H
 
#include <Bpp/Exceptions.h>
#include <Bpp/Numeric/VectorTools.h>
 
#include "SequencedValuesContainer.h"
 
// From the STL:
#include <string>
 
namespace bpp
{
class OrderedValuesContainer :
  virtual public SequencedValuesContainer
{
public:
  OrderedValuesContainer() {}
  virtual ~OrderedValuesContainer() {}
 
  OrderedValuesContainer* clone() const = 0;
 
  using SequencedValuesContainer::toString;
 
  virtual std::string toString(size_t sequenceIndex) const = 0;
 
  virtual const std::string& getName(size_t sequenceIndex) const = 0;
 
  virtual size_t getSequencePosition(const std::string& name) const = 0;
 
  /*
   * @brief get value of a state in a position
   * @param siteIndex  index of the site
   * @param sequenceIndex index of the sequence in the container
   * @param state  state in the alphabet
   */
 
  using SequencedValuesContainer::getStateValueAt;
 
  virtual double getStateValueAt(size_t siteIndex, size_t sequenceIndex, int state) const = 0;
 
  virtual double operator()(size_t siteIndex, size_t sequenceIndex, int state) const = 0;
 
  using SequencedValuesContainer::getComments;
 
  virtual const Comments& getComments(size_t sequenceIndex) const = 0;
 
  using SequencedValuesContainer::setComments;
 
  virtual void setComments(size_t sequenceIndex, const Comments& comments) = 0;
};
} // end of namespace bpp.
#endif // BPP_SEQ_CONTAINER_ORDEREDVALUESCONTAINER_H