ParameterList.h

Go to the documentation of this file.

//
// File: ParameterList.h
// Created by: Julien Dutheil
// Created on: Wed Oct 15 18:17:29 2003
//

/*
   Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)

   This software is a computer program whose purpose is to provide classes
   for numerical calculus.

   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 _PARAMETERLIST_H_
#define _PARAMETERLIST_H_

#include "Parameter.h"
#include "../Clonable.h"
#include "../Io/OutputStream.h"

// From STL:
#include <vector>
#include <string>
#include <iostream>

namespace bpp
{
class ParameterList :
  public Clonable
{
private:
  std::vector<Parameter*> parameters_;

public:
  ParameterList() : parameters_() {}

  ParameterList(const ParameterList& pl);

  ParameterList& operator=(const ParameterList& pl);

  ParameterList* clone() const { return new ParameterList(*this); }

  virtual ~ParameterList();

public:
  size_t size() const { return parameters_.size(); }

  virtual const Parameter& operator[](size_t i) const { return *parameters_[i]; }
  virtual Parameter& operator[](size_t i) { return *parameters_[i]; }

  virtual const Parameter& getParameter(const std::string& name) const throw (ParameterNotFoundException);

  virtual double getParameterValue(const std::string& name) const throw (ParameterNotFoundException);

  virtual Parameter& getParameter(const std::string& name) throw (ParameterNotFoundException);

  virtual ParameterList subList(const std::vector<std::string>& names) const throw (ParameterNotFoundException);

  virtual ParameterList subList(const std::string& name) const throw (ParameterNotFoundException);

  virtual ParameterList subList(const std::vector<size_t>& parameters) const;

  virtual ParameterList subList(size_t parameter) const;

  virtual ParameterList getCommonParametersWith(const ParameterList& params) const;

  virtual std::vector<std::string> getParameterNames() const;

  virtual std::vector<std::string> getMatchingParameterNames(const std::string& pattern) const;

  virtual void addParameter(const Parameter& param) throw (ParameterException);

  virtual void addParameter(Parameter* param) throw (ParameterException);

  virtual void setParameter(size_t index, const Parameter& param) throw (IndexOutOfBoundsException);

  virtual void addParameters(const ParameterList& params) throw (ParameterException);

  virtual void includeParameters(const ParameterList& params);

  virtual void setParameterValue(const std::string& name, double value)
    throw (ParameterNotFoundException, ConstraintException);

  virtual void setAllParametersValues(const ParameterList& params)
    throw (ParameterNotFoundException, ConstraintException);

  virtual void setParametersValues(const ParameterList& params);

  virtual bool hasParameter(const std::string& name) const;

  virtual bool testParametersValues(const ParameterList& params) const;

  virtual bool matchParametersValues(const ParameterList& params, std::vector<size_t>* updatedParameters = 0)
    throw (ConstraintException);

  virtual void setAllParameters(const ParameterList& params)
    throw (ParameterNotFoundException);

  virtual void setParameters(const ParameterList& params)
    throw (ParameterNotFoundException);

  virtual void matchParameters(const ParameterList& params);

  virtual void deleteParameter(const std::string& name) throw (ParameterNotFoundException);

  virtual void deleteParameters(const std::vector<std::string>& names, bool mustExist = true) throw (ParameterNotFoundException);

  virtual void deleteParameter(size_t index) throw (IndexOutOfBoundsException);

  virtual void deleteParameters(const std::vector<size_t>& indices) throw (IndexOutOfBoundsException);

  virtual size_t whichParameterHasName(const std::string& name) const throw (ParameterNotFoundException);

  virtual void printParameters(OutputStream& out) const;

  virtual void printParameters(std::ostream& out) const
  {
    StlOutputStreamWrapper os(&out);
    printParameters(os);
  }

  virtual void reset();
};
} // end of namespace bpp.

#endif  // _PARAMETERLIST_H_