Base class for Function and DerivativesEstimates. More...
#include <FunctionBase.hpp>
Public Member Functions | |
| FunctionBase (size_t const size=0) | |
| Constructor. More... | |
| virtual | ~FunctionBase ()=0 |
| Make the class abstract. More... | |
| size_t | getSize () const |
| Get size of vector for function arguments or zero for arbitrary size. More... | |
Protected Attributes | |
| size_t const | size |
| Size of vector arguments to supply to subclass functions. More... | |
Detailed Description
Base class for Function and DerivativesEstimates.
This class allows you to specify a size for the vectors passed to a Function or DerivativesEstimates object. If no size or size zero (default) is set then the vector size is not checked. Generally, you should set a size unless, for example, you wish to define a function that can act on arbitarily-size vectors.
Definition at line 41 of file FunctionBase.hpp.
Constructor & Destructor Documentation
| FunctionBase::FunctionBase | ( | size_t const | size = 0 | ) |
Constructor.
The size should be set to the size of vector the class takes unless you wish to define a function that can act on any size of vector.
- Parameters
-
size The size of vector for subclass functions.
Definition at line 28 of file FunctionBase.cc.
|
pure virtual |
Make the class abstract.
Definition at line 30 of file FunctionBase.cc.
Member Function Documentation
|
inline |
Get size of vector for function arguments or zero for arbitrary size.
- Returns
- size
Definition at line 57 of file FunctionBase.hpp.
References size.
Referenced by ipo_function::concrete::SumOfSquares::gradient(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::gradient(), ipo_function::detail::PhaseIFunctionAndDerivatives::gradient(), ipo_function::concrete::Sum::gradient(), ipo_function::concrete::SumOfSquares::hessian(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::hessian(), ipo_function::detail::PhaseIFunctionAndDerivatives::hessian(), ipo_function::concrete::Sum::hessian(), ipo_function::detail::PhaseIFunctionAndDerivatives::operator()(), ipo_function::detail::PhaseIFunctionAndDerivatives::PhaseIFunctionAndDerivatives(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::PhaseIObjectiveFunctionAndDerivatives(), ipo_function::detail::ForwardDifferenceGradientEstimate::setVector(), ipo_function::concrete::SumOfSquares::setVector(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::setVector(), ipo_function::detail::PhaseIFunctionAndDerivatives::setVector(), and ipo_function::concrete::Sum::setVector().
Member Data Documentation
|
protected |
Size of vector arguments to supply to subclass functions.
Initialise to zero for arbitrary size.
Definition at line 63 of file FunctionBase.hpp.
Referenced by getSize(), ipo_function::concrete::LinearCombination::resize(), and ipo_function::concrete::QuadraticCombination::resize().
The documentation for this class was generated from the following files:
