MBSim

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

This criteria function class applies the infinity norm globally on the difference between the complete vector of the current step and the complete vector of the step before and compares it with zero (i.e. a shift criteria) More...

#include <criteria_functions.h>

Inheritance diagram for MBSim::GlobalShiftCriteriaFunction:
MBSim::GlobalCriteriaFunction MBSim::CriteriaFunction MBSim::Function1< int, fmatvec::Vec >

List of all members.

Public Member Functions

 GlobalShiftCriteriaFunction (const double &tolerance_=1e-10)
 Constructor.
virtual ~GlobalShiftCriteriaFunction ()
 Destructor.
virtual fmatvec::Vec getLastPoint ()
- Public Member Functions inherited from MBSim::GlobalCriteriaFunction
 GlobalCriteriaFunction (const double &tolerance_=1e-10)
 Constructor.
virtual ~GlobalCriteriaFunction ()
 Destructor.
virtual int operator() (const fmatvec::Vec &vector, const void *=NULL)
 computes the criteria
virtual bool isBetter (const fmatvec::Vec &vector)
 compares the result of given vector with the last result and returns if it got better (for damping)
virtual void clear ()
 deletes the list of criteria results
const std::vector< double > & getResults ()
- Public Member Functions inherited from MBSim::CriteriaFunction
 CriteriaFunction ()
 Constructor.
virtual ~CriteriaFunction ()
 Destructor.
void setFunction (Function1< fmatvec::Vec, fmatvec::Vec > *function_)
- Public Member Functions inherited from MBSim::Function1< int, fmatvec::Vec >
virtual ~Function1 ()
 destructor
virtual void initializeUsingXML (TiXmlElement *element)
 initialize function with XML code

Protected Member Functions

virtual double computeResults (const fmatvec::Vec &x)

Protected Attributes

fmatvec::Vec lastPoint
 save the point of the last step for comparison
- Protected Attributes inherited from MBSim::GlobalCriteriaFunction
double tolerance
 tolerance value for the criteria results
std::vector< double > criteriaResults
 saves the results of the criteria
- Protected Attributes inherited from MBSim::CriteriaFunction
Function1< fmatvec::Vec,
fmatvec::Vec > * 
function
 function that computes the values

Detailed Description

This criteria function class applies the infinity norm globally on the difference between the complete vector of the current step and the complete vector of the step before and compares it with zero (i.e. a shift criteria)


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