RSC  0.16.0
rsc::math::BelowThreshold Class Reference

The BelowThreshold - condition tests whether a given metric of two vectors stays below a given upper threshold. More...

#include <SequenceMonitor.h>

Inheritance diagram for rsc::math::BelowThreshold:
Inheritance graph
Collaboration diagram for rsc::math::BelowThreshold:
Collaboration graph

Public Member Functions

 BelowThreshold (const MetricPtr m, const double threshold)
 
bool isFulfilled (const double *v1, const double *v2, const unsigned int &dim)
 tests whether two vectors fulfill the BelowUpperThreshold - condition More...
 
- Public Member Functions inherited from rsc::math::MetricCondition
 MetricCondition (MetricPtr m)
 
virtual ~MetricCondition ()
 

Protected Attributes

const double threshold
 
- Protected Attributes inherited from rsc::math::MetricCondition
const MetricPtr metric
 

Detailed Description

The BelowThreshold - condition tests whether a given metric of two vectors stays below a given upper threshold.

Author
cemmeric

Definition at line 148 of file SequenceMonitor.h.

Constructor & Destructor Documentation

rsc::math::BelowThreshold::BelowThreshold ( const MetricPtr  m,
const double  threshold 
)

Definition at line 64 of file SequenceMonitor.cpp.

Member Function Documentation

bool rsc::math::BelowThreshold::isFulfilled ( const double *  v1,
const double *  v2,
const unsigned int &  dim 
)
virtual

tests whether two vectors fulfill the BelowUpperThreshold - condition

Parameters
v1a vector
v2another vector
dimdimension of both given vectors
Returns
true, if metric(v1, v2) < threshold

Implements rsc::math::MetricCondition.

Definition at line 68 of file SequenceMonitor.cpp.

References rsc::math::MetricCondition::metric, and threshold.

Member Data Documentation

const double rsc::math::BelowThreshold::threshold
protected

Definition at line 164 of file SequenceMonitor.h.

Referenced by isFulfilled().


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