ParameterList.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#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>& getParameter(size_t i) const { return parameters_[i]; }
  virtual std::shared_ptr<Parameter>& getParameter(size_t i) { return parameters_[i]; }

  virtual const Parameter& parameter(const std::string& name) const;

  virtual const std::shared_ptr<Parameter>& getParameter(const std::string& name) const;

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

  virtual Parameter& parameter(const std::string& name);

  virtual std::shared_ptr<Parameter>& getParameter(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