FunctionTools.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_FUNCTION_FUNCTIONTOOLS_H
#define BPP_NUMERIC_FUNCTION_FUNCTIONTOOLS_H


#include "../VectorTools.h"
#include "../DataTable.h"
#include "Functions.h"

namespace bpp
{
class ParameterGrid
{
private:
  std::vector<std::string> names_;
  VVdouble grid_;

public:
  ParameterGrid() : names_(), grid_() {}
  virtual ~ParameterGrid() {}

public:
  void addDimension(const std::string& name, const Vdouble& values);

  const std::vector<std::string>& getDimensionNames() const { return names_; }

  const std::string& getDimensionName(unsigned int i) const
  {
    if (i >= names_.size()) throw IndexOutOfBoundsException("ParameterGrid::getDimensionName().", i, 0, names_.size() - 1);
    return names_[i];
  }

  size_t getNumberOfDimensions() const { return names_.size(); }

  size_t getTotalNumberOfPoints() const;

  const VVdouble& getPoints() const { return grid_; }
  const Vdouble& getPointsForDimension(unsigned int i) const;
  const Vdouble& getPointsForDimension(const std::string& name) const;
};

class FunctionTools
{
public:
  static std::shared_ptr<DataTable> computeGrid(
      FunctionInterface& function,
      const ParameterGrid& grid);
};
} // end of namespace bpp
#endif // BPP_NUMERIC_FUNCTION_FUNCTIONTOOLS_H