STK::Stat::MinSafeOp< Derived > Struct Template Reference

Compute safely the minimal value of the variable V. More...

#include <STK_Stat_Functors.h>

Public Types
typedef Derived::Type	Type

Public Member Functions
	MinSafeOp (ExprBase< Derived > const &V)
	constructor
Type const	operator() () const
template<class Weights >
Type const	operator() (ExprBase< Weights > const &w) const

Protected Attributes
Derived const &	V_

Detailed Description

template<class Derived>
struct STK::Stat::MinSafeOp< Derived >

Compute safely the minimal value of the variable V.

Definition at line 114 of file STK_Stat_Functors.h.

Member Typedef Documentation

Type

template<class Derived >

typedef Derived::Type STK::Stat::MinSafeOp< Derived >::Type

Definition at line 116 of file STK_Stat_Functors.h.

Constructor & Destructor Documentation

MinSafeOp()

template<class Derived >

STK::Stat::MinSafeOp< Derived >::MinSafeOp ( ExprBase< Derived > const &  V )

inline

constructor

Definition at line 118 of file STK_Stat_Functors.h.

                                                   :  V_(V.asDerived())
    { STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

Member Function Documentation

operator()() [1/2]

template<class Derived >

Type const STK::Stat::MinSafeOp< Derived >::operator() ( ) const

inline

Returns

the safely computed minimal value of the variable V

Definition at line 121 of file STK_Stat_Functors.h.

    {
      Type min  = Arithmetic<Type>::max();
      for (int i=V_.begin(); i<V_.end(); i++)
      { if (Arithmetic<Type>::isFinite(V_[i])) min = std::min(min, V_[i]);}
      return min;
    }

References STK::Stat::min(), and STK::Stat::MinSafeOp< Derived >::V_.

operator()() [2/2]

template<class Derived >

template<class Weights >

Type const STK::Stat::MinSafeOp< Derived >::operator() ( ExprBase< Weights > const &  w ) const

inline

Returns

the safely computed weighted minimal value of the variable V

Parameters

w	the weights

Definition at line 132 of file STK_Stat_Functors.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Weights);
      Type min  = Arithmetic<Type>::max();
      for (int i=V_.begin(); i<V_.end(); i++)
      { if (!Arithmetic<Type>::isNA(V_[i])) min = std::min(min, w[i]*V_[i]);}
      return min;
    }

References STK::Stat::min(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STK::Stat::MinSafeOp< Derived >::V_.

Member Data Documentation

V_

template<class Derived >

Derived const& STK::Stat::MinSafeOp< Derived >::V_

protected

Definition at line 141 of file STK_Stat_Functors.h.

Referenced by STK::Stat::MinSafeOp< Derived >::operator()(), and STK::Stat::MinSafeOp< Derived >::operator()().

---

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

• STK_Stat_Functors.h