Multi-modal two-dimensional continuous Himmelblau benchmark function. More...
#include <shark/ObjectiveFunctions/Benchmarks/Himmelblau.h>
Inheritance diagram for shark::Himmelblau:
Public Member Functions | |
| Himmelblau () | |
| Constructs an instance of the function. More... | |
| std::string | name () const |
| From INameable: return the class name. More... | |
| std::size_t | numberOfVariables () const |
| Accesses the number of variables. More... | |
| SearchPointType | proposeStartingPoint () const |
| Proposes a starting point in the feasible search space of the function. More... | |
| double | eval (const SearchPointType &p) const |
| Evaluates the function for the supplied search point. More... | |
| Public Member Functions inherited from shark::AbstractObjectiveFunction< PointType, ResultT > | |
| const Features & | features () const |
| virtual void | updateFeatures () |
| bool | hasValue () const |
| returns whether this function can calculate it's function value More... | |
| bool | hasFirstDerivative () const |
| returns whether this function can calculate the first derivative More... | |
| bool | hasSecondDerivative () const |
| returns whether this function can calculate the second derivative More... | |
| bool | canProposeStartingPoint () const |
| returns whether this function can propose a starting point. More... | |
| bool | isConstrained () const |
| returns whether this function can return More... | |
| bool | hasConstraintHandler () const |
| returns whether this function can return More... | |
| bool | canProvideClosestFeasible () const |
| Returns whether this function can calculate thee closest feasible to an infeasible point. More... | |
| bool | isThreadSafe () const |
| Returns true, when the function can be usd in parallel threads. More... | |
| bool | isNoisy () const |
| Returns true, when the function can be usd in parallel threads. More... | |
| AbstractObjectiveFunction () | |
| Default ctor. More... | |
| virtual | ~AbstractObjectiveFunction () |
| Virtual destructor. More... | |
| virtual void | init () |
| void | setRng (random::rng_type *rng) |
| Sets the Rng used by the objective function. More... | |
| virtual bool | hasScalableDimensionality () const |
| virtual void | setNumberOfVariables (std::size_t numberOfVariables) |
| Adjusts the number of variables if the function is scalable. More... | |
| virtual std::size_t | numberOfObjectives () const |
| virtual bool | hasScalableObjectives () const |
| virtual void | setNumberOfObjectives (std::size_t numberOfObjectives) |
| Adjusts the number of objectives if the function is scalable. More... | |
| std::size_t | evaluationCounter () const |
| Accesses the evaluation counter of the function. More... | |
| AbstractConstraintHandler< SearchPointType > const & | getConstraintHandler () const |
| Returns the constraint handler of the function if it has one. More... | |
| virtual bool | isFeasible (const SearchPointType &input) const |
| Tests whether a point in SearchSpace is feasible, e.g., whether the constraints are fulfilled. More... | |
| virtual void | closestFeasible (SearchPointType &input) const |
| If supported, the supplied point is repaired such that it satisfies all of the function's constraints. More... | |
| ResultType | operator() (SearchPointType const &input) const |
| Evaluates the function. Useful together with STL-Algorithms like std::transform. More... | |
| virtual ResultType | evalDerivative (SearchPointType const &input, FirstOrderDerivative &derivative) const |
| Evaluates the objective function and calculates its gradient. More... | |
| virtual ResultType | evalDerivative (SearchPointType const &input, SecondOrderDerivative &derivative) const |
| Evaluates the objective function and calculates its gradient. More... | |
| Public Member Functions inherited from shark::INameable | |
| virtual | ~INameable () |
Detailed Description
Multi-modal two-dimensional continuous Himmelblau benchmark function.
Implements Himmelblau's real-valued, multi-modal benchmark function. The function is limited to two dimensions. Please see: http://en.wikipedia.org/wiki/Himmelblau%27s_function for further information.
Definition at line 49 of file Himmelblau.h.
Constructor & Destructor Documentation
◆ Himmelblau()
|
inline |
Constructs an instance of the function.
Definition at line 53 of file Himmelblau.h.
References shark::AbstractObjectiveFunction< PointType, ResultT >::CAN_PROPOSE_STARTING_POINT, and shark::AbstractObjectiveFunction< PointType, ResultT >::m_features.
Member Function Documentation
◆ eval()
|
inlinevirtual |
Evaluates the function for the supplied search point.
- Exceptions
-
shark::Exception if the size of p does not equal 2.
Reimplemented from shark::AbstractObjectiveFunction< PointType, ResultT >.
Definition at line 78 of file Himmelblau.h.
References shark::AbstractObjectiveFunction< PointType, ResultT >::m_evaluationCounter, SIZE_CHECK, and shark::sqr().
◆ name()
|
inlinevirtual |
From INameable: return the class name.
Reimplemented from shark::INameable.
Definition at line 58 of file Himmelblau.h.
◆ numberOfVariables()
|
inlinevirtual |
Accesses the number of variables.
Implements shark::AbstractObjectiveFunction< PointType, ResultT >.
Definition at line 61 of file Himmelblau.h.
Referenced by proposeStartingPoint().
◆ proposeStartingPoint()
|
inlinevirtual |
Proposes a starting point in the feasible search space of the function.
- Returns
- The generated starting point.
- Exceptions
-
FeatureNotAvailableException in the default implementation and if a function does not support this feature.
Reimplemented from shark::AbstractObjectiveFunction< PointType, ResultT >.
Definition at line 65 of file Himmelblau.h.
References shark::AbstractObjectiveFunction< PointType, ResultT >::mep_rng, numberOfVariables(), and shark::random::uni().
The documentation for this struct was generated from the following file:
- include/shark/ObjectiveFunctions/Benchmarks/Himmelblau.h