highprecisionpso::PotentialFunctionDifference Class Reference

This potential calculator can calculate the function difference statistic. More...

#include <potential_calculator.h>

Inheritance diagram for highprecisionpso::PotentialFunctionDifference:

Public Member Functions

mpf_t * Evaluate (Particle *p, int dim)
 Calculates for a specific particle and a specific dimension the function difference statistic. More...
 
std::string GetName ()
 Returns a string representation of this object. More...
 
- Public Member Functions inherited from highprecisionpso::PotentialCalculator
std::vector< std::vector< mpf_t * > > Evaluate ()
 Calculates for all particles and dimensions the statistical values. More...
 
- Public Member Functions inherited from highprecisionpso::SpecificStatisticalEvaluation
virtual ~SpecificStatisticalEvaluation ()
 

Detailed Description

This potential calculator can calculate the function difference statistic.

Member Function Documentation

mpf_t* highprecisionpso::PotentialFunctionDifference::Evaluate ( Particle p,
int  dim 
)
virtual

Calculates for a specific particle and a specific dimension the function difference statistic.

Let x be the position of the particle.
Let v be the velocity of the particle.
Let f be the objective function.
Let x' be a position such that x'[dim] = x[dim] + v[dim] and x'[d] = x[d] for all dimensions not equal to dim.
Then the result of the function difference statistic is abs( f ( x ) - f ( x' ) ).

Parameters
pThe particle.
dimThe dimension index.
Returns
The statistical value.

Implements highprecisionpso::PotentialCalculator.

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

Returns a string representation of this object.

Returns
The name of the object.

Implements highprecisionpso::SpecificStatisticalEvaluation.


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