This class is a data structure to specify a set of parameter values (most likely for evaluation by a Function)
More...
#include <Bpp/Numeric/Function/FunctionTools.h>
This class is a data structure to specify a set of parameter values (most likely for evaluation by a Function)
- See also
- FunctionTools
Definition at line 54 of file FunctionTools.h.
◆ ParameterGrid()
bpp::ParameterGrid::ParameterGrid |
( |
| ) |
|
|
inline |
◆ ~ParameterGrid()
virtual bpp::ParameterGrid::~ParameterGrid |
( |
| ) |
|
|
inlinevirtual |
◆ addDimension()
void ParameterGrid::addDimension |
( |
const std::string & |
name, |
|
|
const Vdouble & |
values |
|
) |
| |
throw | ( | Exception |
| ) | | |
Add a new dimension (parameter name + corresponding values).
- Parameters
-
name | The name of the dimension (parameter name). |
values | The values the parameter will take. |
- Exceptions
-
Exception | in case the dimension is note valid (duplicated parameter name for instance). |
Definition at line 49 of file FunctionTools.cpp.
◆ getDimensionName()
◆ getDimensionNames()
const std::vector<std::string>& bpp::ParameterGrid::getDimensionNames |
( |
| ) |
const |
|
inline |
◆ getNumberOfDimensions()
size_t bpp::ParameterGrid::getNumberOfDimensions |
( |
| ) |
const |
|
inline |
◆ getPoints()
const VVdouble& bpp::ParameterGrid::getPoints |
( |
| ) |
const |
|
inline |
◆ getPointsForDimension() [1/2]
◆ getPointsForDimension() [2/2]
const Vdouble & ParameterGrid::getPointsForDimension |
( |
const std::string & |
name | ) |
const |
throw | ( | Exception |
| ) | | |
◆ getTotalNumberOfPoints()
size_t ParameterGrid::getTotalNumberOfPoints |
( |
| ) |
const |
- Returns
- The total number of points in the grid, that is the product of all dimension sizes.
Definition at line 71 of file FunctionTools.cpp.
◆ grid_
◆ names_
std::vector<std::string> bpp::ParameterGrid::names_ |
|
private |
The documentation for this class was generated from the following files: