highprecisionpso::InclinedPlane Class Reference

This class implements the inclined plane function, which represents a function with constant first derivative. More...

#include <inclined_plane.h>

Inheritance diagram for highprecisionpso::InclinedPlane:

Public Member Functions

 InclinedPlane ()
 The constructor. More...
 
mpf_t * DistanceTo1DLocalOptimum (const std::vector< mpf_t * > &pos, int d)
 Returns always +infinity, because the optimum can not be reached. More...
 
mpf_t * Eval (const std::vector< mpf_t * > &pos)
 Returns the sum of the vector entries multiplied by -1. More...
 
std::string GetName ()
 Returns a string representation of this object. More...
 
- Public Member Functions inherited from highprecisionpso::Function
 Function ()
 A constructor. More...
 
 Function (double search_space_lower_bound, double search_space_upper_bound)
 A constructor, specifying the lower and upper search space bounds. More...
 
 Function (std::vector< double > search_space_lower_bound, std::vector< double > search_space_upper_bound)
 A constructor specifying the lower and upper search space bounds. More...
 
virtual ~Function ()
 The destructor. More...
 
virtual mpf_t * DistanceTo1DLocalOptimumTernarySearch (const std::vector< mpf_t * > &pos, int d, mpf_t *start_distance)
 Calculates for a position and a dimension the next local optimum if only the value of the position in the specified dimension is varied and returns the distance to it. More...
 
mpf_t * Evaluate (const std::vector< mpf_t * > &pos)
 This is the initial function for evaluation of a position. More...
 
virtual std::vector< mpf_t * > GetLowerSearchSpaceBound ()
 Returns the lower search space bound of the search space for this objective function. More...
 
virtual std::vector< mpf_t * > GetUpperSearchSpaceBound ()
 Returns the upper search space bound of the search space for this objective function. More...
 
void InitSearchSpaceBounds ()
 Initializes the search space bounds. More...
 
void SetFunctionBound (SearchSpaceBound *search_space_bound)
 Updates the bound of the search space according to the given data. More...
 

Detailed Description

This class implements the inclined plane function, which represents a function with constant first derivative.

Constructor & Destructor Documentation

highprecisionpso::InclinedPlane::InclinedPlane ( )

The constructor.

Member Function Documentation

mpf_t* highprecisionpso::InclinedPlane::DistanceTo1DLocalOptimum ( const std::vector< mpf_t * > &  pos,
int  d 
)
virtual

Returns always +infinity, because the optimum can not be reached.

Parameters
posThe position.
dThe dimension index.
Returns
+infinity.

Reimplemented from highprecisionpso::Function.

mpf_t* highprecisionpso::InclinedPlane::Eval ( const std::vector< mpf_t * > &  pos)
virtual

Returns the sum of the vector entries multiplied by -1.

Parameters
posThe position.
Returns
The negative vector sum.

Implements highprecisionpso::Function.

std::string highprecisionpso::InclinedPlane::GetName ( )
virtual

Returns a string representation of this object.

Returns
The name of the object.

Implements highprecisionpso::Function.


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