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

Compute safely mean of the variable V. More...

#include <STK_Stat_Functors.h>

Public Types
typedef Derived::Type	Type

Public Member Functions
	MeanSafeOp (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::MeanSafeOp< Derived >

Compute safely mean of the variable V.

Definition at line 344 of file STK_Stat_Functors.h.

Member Typedef Documentation

Type

template<class Derived >

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

Definition at line 346 of file STK_Stat_Functors.h.

Constructor & Destructor Documentation

MeanSafeOp()

template<class Derived >

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

inline

constructor

Definition at line 348 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::MeanSafeOp< Derived >::operator() ( ) const

inline

Returns

the safely computed mean of the variable V discarding all missing values.

Definition at line 351 of file STK_Stat_Functors.h.

    {
      // no samples
      if (V_.empty()) { return Type(0);}
      // get dimensions
      int nobs = V_.size();
      // sum the samples
      Type sum  = 0.0;
      for (int i=V_.begin(); i<V_.end(); i++)
      { (!Arithmetic<Type>::isNA(V_[i])) ? sum += V_[i] : nobs--;}
      // compute the mean
      return nobs ? (sum /= Type(nobs)) : Type(0);
    }

References STK::Arithmetic< Type >::isNA(), STK::Stat::sum(), and STK::Stat::MeanSafeOp< Derived >::V_.

operator()() [2/2]

template<class Derived >

template<class Weights >

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

inline

Returns

the safely computed weighted mean of the variable V

Parameters

w	the weights

Definition at line 368 of file STK_Stat_Functors.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Weights);
      // no samples
      if (V_.empty()) { return Type(0);}
#ifdef STK_BOUNDS_CHECK
      if (V_.range() != w.range())
        STKRUNTIME_ERROR_NO_ARG(wmeanSafe,V.range()!=w.range());
#endif
      // sum the weighted samples
      Type sum  = 0.0, sumweights= 0.0;
      for (int i=V_.begin(); i<V_.end(); i++)
      { if ( (!Arithmetic<Type>::isNA(V_[i])) && (!Arithmetic<Type>::isNA(w[i])))
        {
          Type weight  = std::abs(w[i]);
          sumweights += weight;
          sum        += weight * V_[i];
        }
      }
      // compute the weighted mean. If all weights are 0, we get 0
      return (sumweights) ? (sum / sumweights) : Type(0);
    }

References STK::Arithmetic< Type >::isNA(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, STKRUNTIME_ERROR_NO_ARG, STK::Stat::sum(), and STK::Stat::MeanSafeOp< Derived >::V_.

Member Data Documentation

V_

template<class Derived >

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

protected

Definition at line 391 of file STK_Stat_Functors.h.

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

---

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

• STK_Stat_Functors.h