Convex quadratic benchmark function with single dominant axis. More...

#include <shark/ObjectiveFunctions/Benchmarks/Cigar.h>

Inheritance diagram for shark::Cigar:

Public Member Functions
	Cigar (std::size_t numberOfVariables=5, double alpha=1.E-3)

std::string	name () const
	From INameable: return the class name. More...

std::size_t	numberOfVariables () const
	Accesses the number of variables. More...

bool	hasScalableDimensionality () const

void	setNumberOfVariables (std::size_t numberOfVariables)
	Adjusts the number of variables if the function is scalable. 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 objective function for the supplied argument. More...

double	evalDerivative (SearchPointType const &p, FirstOrderDerivative &derivative) const
	Evaluates the objective function and calculates its gradient. More...

double	alpha () const

void	setAlpha (double alpha)

Public Member Functions inherited from shark::AbstractObjectiveFunction< RealVector, double >
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 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, SecondOrderDerivative &derivative) const
	Evaluates the objective function and calculates its gradient. More...

Public Member Functions inherited from shark::INameable
virtual	~INameable ()

Additional Inherited Members
Public Types inherited from shark::AbstractObjectiveFunction< RealVector, double >
enum	Feature
	List of features that are supported by an implementation. More...

typedef RealVector	SearchPointType

typedef double	ResultType

typedef boost::mpl::if_< std::is_arithmetic< double >, SearchPointType, RealMatrix >::type	FirstOrderDerivative

typedef TypedFlags< Feature >	Features
	This statement declares the member m_features. See Core/Flags.h for details. More...

typedef TypedFeatureNotAvailableException< Feature >	FeatureNotAvailableException

Protected Member Functions inherited from shark::AbstractObjectiveFunction< RealVector, double >
void	announceConstraintHandler (AbstractConstraintHandler< SearchPointType > const *handler)
	helper function which is called to announce the presence of an constraint handler. More...

Protected Attributes inherited from shark::AbstractObjectiveFunction< RealVector, double >
Features	m_features

std::size_t	m_evaluationCounter
	Evaluation counter, default value: 0. More...

AbstractConstraintHandler< SearchPointType > const *	m_constraintHandler

random::rng_type *	mep_rng

Detailed Description

Convex quadratic benchmark function with single dominant axis.

Definition at line 42 of file Cigar.h.

Constructor & Destructor Documentation

◆ Cigar()

shark::Cigar::Cigar	(	std::size_t	numberOfVariables = `5`,
		double	alpha = `1.E-3`
	)

inline

Definition at line 44 of file Cigar.h.

References shark::AbstractObjectiveFunction< RealVector, double >::CAN_PROPOSE_STARTING_POINT, shark::AbstractObjectiveFunction< RealVector, double >::HAS_FIRST_DERIVATIVE, shark::AbstractObjectiveFunction< RealVector, double >::m_features, and numberOfVariables().

Member Function Documentation

◆ alpha()

double shark::Cigar::alpha ( ) const

inline

Definition at line 91 of file Cigar.h.

Referenced by setAlpha().

◆ eval()

double shark::Cigar::eval ( const SearchPointType & input ) const

inlinevirtual

Evaluates the objective function for the supplied argument.

Parameters

[in] input The argument for which the function shall be evaluated.

Returns: The result of evaluating the function for the supplied argument.

Exceptions

FeatureNotAvailableException in the default implementation and if a function does not support this feature.

Reimplemented from shark::AbstractObjectiveFunction< RealVector, double >.

Definition at line 75 of file Cigar.h.

References shark::AbstractObjectiveFunction< RealVector, double >::m_evaluationCounter.

◆ evalDerivative()

double shark::Cigar::evalDerivative	(	SearchPointType const &	input,
		FirstOrderDerivative &	derivative
	)		const

inlinevirtual

Evaluates the objective function and calculates its gradient.

Parameters

[in]	input	The argument to eval the function for.
[out]	derivative	The derivate is placed here.

Returns: The result of evaluating the function for the supplied argument.

Exceptions

FeatureNotAvailableException in the default implementation and if a function does not support this feature.

Reimplemented from shark::AbstractObjectiveFunction< RealVector, double >.

Definition at line 84 of file Cigar.h.

◆ hasScalableDimensionality()

bool shark::Cigar::hasScalableDimensionality ( ) const

inlinevirtual

Reimplemented from shark::AbstractObjectiveFunction< RealVector, double >.

Definition at line 58 of file Cigar.h.

◆ name()

std::string shark::Cigar::name ( ) const

inlinevirtual

From INameable: return the class name.

Reimplemented from shark::INameable.

Definition at line 51 of file Cigar.h.

◆ numberOfVariables()

std::size_t shark::Cigar::numberOfVariables ( ) const

inlinevirtual

Accesses the number of variables.

Implements shark::AbstractObjectiveFunction< RealVector, double >.

Definition at line 54 of file Cigar.h.

Referenced by Cigar(), proposeStartingPoint(), and setNumberOfVariables().

◆ proposeStartingPoint()

SearchPointType shark::Cigar::proposeStartingPoint ( ) const

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< RealVector, double >.

Definition at line 66 of file Cigar.h.

References shark::AbstractObjectiveFunction< RealVector, double >::mep_rng, numberOfVariables(), and shark::random::uni().

◆ setAlpha()

void shark::Cigar::setAlpha ( double alpha )

inline

Definition at line 95 of file Cigar.h.

References alpha().

◆ setNumberOfVariables()

void shark::Cigar::setNumberOfVariables ( std::size_t numberOfVariables )

inlinevirtual

Adjusts the number of variables if the function is scalable.

Parameters

[in] numberOfVariables The new dimension.

Reimplemented from shark::AbstractObjectiveFunction< RealVector, double >.

Definition at line 62 of file Cigar.h.

References numberOfVariables().

The documentation for this struct was generated from the following file:

include/shark/ObjectiveFunctions/Benchmarks/Cigar.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Cigar()

Member Function Documentation

◆ alpha()

◆ eval()

◆ evalDerivative()

◆ hasScalableDimensionality()

◆ name()

◆ numberOfVariables()

◆ proposeStartingPoint()

◆ setAlpha()

◆ setNumberOfVariables()