shark::AbstractVectorSpaceObjectiveFunction Class Referenceabstract

Models a vector space objective function storing the number of variables. More...

#include <shark/ObjectiveFunctions/AbstractObjectiveFunction.h>

Collaboration diagram for shark::AbstractVectorSpaceObjectiveFunction:

## Public Member Functions

virtual ~AbstractVectorSpaceObjectiveFunction ()
Virtual d'tor.

virtual std::size_t numberOfVariables () const =0
Accesses the number of variables.

virtual bool hasScalableDimensionality () const

virtual void setNumberOfVariables (std::size_t numberOfVariables)
Adjusts the number of variables if the function is scalable.

## Detailed Description

Models a vector space objective function storing the number of variables.

AbstractObjectiveFunction derives itself from this interface, when the search space type is a vector space and thus the notion of a number of variabls makes sense. This class is otherwise not intended for direct use.

Definition at line 57 of file AbstractObjectiveFunction.h.

## Constructor & Destructor Documentation

 virtual shark::AbstractVectorSpaceObjectiveFunction::~AbstractVectorSpaceObjectiveFunction ( )
inlinevirtual

Virtual d'tor.

Definition at line 60 of file AbstractObjectiveFunction.h.

## Member Function Documentation

 virtual bool shark::AbstractVectorSpaceObjectiveFunction::hasScalableDimensionality ( ) const
inlinevirtual

Definition at line 65 of file AbstractObjectiveFunction.h.

 virtual std::size_t shark::AbstractVectorSpaceObjectiveFunction::numberOfVariables ( ) const
pure virtual

Accesses the number of variables.

 virtual void shark::AbstractVectorSpaceObjectiveFunction::setNumberOfVariables ( std::size_t numberOfVariables )
inlinevirtual

Adjusts the number of variables if the function is scalable.

Parameters
 [in] numberOfVariables The new dimension.

Definition at line 71 of file AbstractObjectiveFunction.h.

References SHARKEXCEPTION.

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