highprecisionpso::ComposedParticleReduceOperation Class Reference

This class implements a reduce operation, which reduces the values of all particles to a single value. More...

#include <specific_statistical_evaluations.h>

Inheritance diagram for highprecisionpso::ComposedParticleReduceOperation:

Public Member Functions

 ComposedParticleReduceOperation (VectorReduceOperation *vector_reduce_operation)
 The constructor, where the reduce operation can be specified. More...
 
std::vector< mpf_t * > Evaluate (const std::vector< std::vector< mpf_t * > > &data)
 Reduces the entries of the given data matrix to a vector. More...
 
std::string GetName ()
 Returns a string representation of this object. More...
 
- Public Member Functions inherited from highprecisionpso::ComposedStatisticReduceOperation
 ComposedStatisticReduceOperation (VectorReduceOperation *vector_reduce_operation)
 The constructor, where the reduce operation can be specified. More...
 
- Public Member Functions inherited from highprecisionpso::StatisticReduceOperation
virtual ~StatisticReduceOperation ()
 

Additional Inherited Members

- Protected Attributes inherited from highprecisionpso::ComposedStatisticReduceOperation
VectorReduceOperationvector_reduce_operation
 The stored vector reduce operation. More...
 

Detailed Description

This class implements a reduce operation, which reduces the values of all particles to a single value.

Constructor & Destructor Documentation

highprecisionpso::ComposedParticleReduceOperation::ComposedParticleReduceOperation ( VectorReduceOperation vector_reduce_operation)

The constructor, where the reduce operation can be specified.

Parameters
vector_reduce_operationThe reduce operation.

Member Function Documentation

std::vector<mpf_t*> highprecisionpso::ComposedParticleReduceOperation::Evaluate ( const std::vector< std::vector< mpf_t * > > &  data)
virtual

Reduces the entries of the given data matrix to a vector.

The data matrix contains a vector for each particle and each of those vectors has an entry for each dimension of the search space. This reduce operation reduces the particles together and therefore produces a value for each dimension of the search space. For example if the vector reduce operation calculates an average and the data matrix contains the positions of the particles, then an average position is calculated.

Parameters
dataThe data matrix.
Returns
The reduced vector.

Implements highprecisionpso::ComposedStatisticReduceOperation.

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

Returns a string representation of this object.

Returns
The name of this object.

Implements highprecisionpso::ComposedStatisticReduceOperation.


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