highprecisionpso::ConstantSpecificStatisticalEvaluation Class Reference

This class implements a specific statistical evaluation, which always evaluates to the same value. More...

#include <specific_statistical_evaluations.h>

Inheritance diagram for highprecisionpso::ConstantSpecificStatisticalEvaluation:

Public Member Functions

 ConstantSpecificStatisticalEvaluation (ConstantEvaluation *constant_evaluation)
 The constructor, where the generation of the constant value can be specified. More...
 
std::vector< std::vector< mpf_t * > > Evaluate ()
 Returns the matrix with constant content as specified. More...
 
std::string GetName ()
 Returns a string representation of this object. More...
 
- Public Member Functions inherited from highprecisionpso::SpecificStatisticalEvaluation
virtual ~SpecificStatisticalEvaluation ()
 

Detailed Description

This class implements a specific statistical evaluation, which always evaluates to the same value.

This statistic can be combined with other statistics to evaluate for example the distance to some constant value.

Constructor & Destructor Documentation

highprecisionpso::ConstantSpecificStatisticalEvaluation::ConstantSpecificStatisticalEvaluation ( ConstantEvaluation constant_evaluation)

The constructor, where the generation of the constant value can be specified.

Parameters
constant_evaluationThe generation method for the constant value.

Member Function Documentation

std::vector<std::vector<mpf_t*> > highprecisionpso::ConstantSpecificStatisticalEvaluation::Evaluate ( )
virtual

Returns the matrix with constant content as specified.

The result contains as many vectors as the number of particles. Each of these vectors contains as many values as the number of dimensions of the search space.

Returns
The constant matrix.

Implements highprecisionpso::SpecificStatisticalEvaluation.

std::string highprecisionpso::ConstantSpecificStatisticalEvaluation::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: