MBSim

Project Page
Public Member Functions | Protected Attributes
MBSim::CriteriaFunction Class Reference

Mother class for different criterias that are fulfilled or not. More...

#include <criteria_functions.h>

Inheritance diagram for MBSim::CriteriaFunction:
MBSim::Function1< int, fmatvec::Vec > MBSim::Function MBSim::edgePolyFrustumCriteria MBSim::GlobalCriteriaFunction MBSim::LocalCriteriaFunction MBSim::GlobalResidualCriteriaFunction MBSim::GlobalShiftCriteriaFunction MBSim::LocalResidualCriteriaFunction MBSim::LocalShiftCriteriaFunction

List of all members.

Public Member Functions

 CriteriaFunction ()
 Constructor.
virtual ~CriteriaFunction ()
 Destructor.
void setFunction (Function1< fmatvec::Vec, fmatvec::Vec > *function_)
virtual int operator() (const fmatvec::Vec &vector, const void *=NULL)=0
 computes the criteria
virtual void clear ()=0
 deletes the list of criteria results
virtual bool isBetter (const fmatvec::Vec &vector)=0
 compares the result of given vector with the last result and returns if it got better (for damping)

Protected Attributes

Function1< fmatvec::Vec,
fmatvec::Vec > * 
function
 function that computes the values

Detailed Description

Mother class for different criterias that are fulfilled or not.


Member Function Documentation

virtual int MBSim::CriteriaFunction::operator() ( const fmatvec::Vec &  vector,
const void *  = NULL 
) [pure virtual]

computes the criteria

The criteria has to fulfill at least:

  • result = 0: the criteria is fulfilled and should stop
  • result = 1: the algorithm should go on
  • result = 2: the algorithm has slow convergence and should stop
  • result = -1: the algorithm diverges and should stop

Implements MBSim::Function1< int, fmatvec::Vec >.

Implemented in MBSim::LocalCriteriaFunction, MBSim::edgePolyFrustumCriteria, and MBSim::GlobalCriteriaFunction.


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