ParameterList.h

Go to the documentation of this file.

//
// File: ParameterList.h
// Authors:
//   Julien Dutheil
// Created: 2003-10-15 18:17:29
//
 
/*
  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 BPP_NUMERIC_PARAMETERLIST_H
#define BPP_NUMERIC_PARAMETERLIST_H
 
 
#include "../Clonable.h"
#include "../Io/OutputStream.h"
#include "Parameter.h"
 
// From STL:
#include <vector>
#include <string>
#include <iostream>
 
namespace bpp
{
class ParameterList :
  public Clonable
{
private:
  std::vector<std::shared_ptr<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 std::shared_ptr<Parameter>& getSharedParameter(size_t i) const { return parameters_[i]; }
  virtual std::shared_ptr<Parameter>& getSharedParameter(size_t i) { return parameters_[i]; }
 
  virtual const Parameter& getParameter(const std::string& name) const;
 
  virtual const std::shared_ptr<Parameter>& getSharedParameter(const std::string& name) const;
 
  virtual double getParameterValue(const std::string& name) const;
 
  virtual Parameter& getParameter(const std::string& name);
 
  virtual std::shared_ptr<Parameter>& getSharedParameter(const std::string& name);
 
  virtual ParameterList createSubList(const std::vector<std::string>& names) const;
 
  virtual ParameterList shareSubList(const std::vector<std::string>& names) const;
 
  virtual ParameterList createSubList(const std::string& name) const;
 
  virtual ParameterList createSubList(const std::vector<size_t>& parameters) const;
 
  virtual ParameterList shareSubList(const std::vector<size_t>& parameters) const;
 
  virtual ParameterList createSubList(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);
 
  virtual void addParameter(Parameter* param);
 
  virtual void shareParameter(const std::shared_ptr<Parameter>& param);
 
 
  virtual void setParameter(size_t index, const Parameter& param);
 
//  virtual void setParameter(size_t index, Parameter* param);
 
  virtual void addParameters(const ParameterList& params);
 
  virtual void shareParameters(const ParameterList& params);
 
  virtual void includeParameters(const ParameterList& params);
 
  virtual void setParameterValue(const std::string& name, double value);
 
  virtual void setAllParametersValues(const ParameterList& params);
 
  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);
 
  virtual void setAllParameters(const ParameterList& params);
 
  virtual void setParameters(const ParameterList& params);
 
  virtual void matchParameters(const ParameterList& params);
 
  virtual void deleteParameter(const std::string& name);
 
  virtual void deleteParameters(const std::vector<std::string>& names, bool mustExist = true);
 
  virtual void deleteParameter(size_t index);
 
  virtual void deleteParameters(const std::vector<size_t>& indices);
 
  virtual size_t whichParameterHasName(const std::string& name) const;
 
  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 // BPP_NUMERIC_PARAMETERLIST_H