Compute the sum of the variable V. More...

#include <STK_Stat_Functors.h>

Public Types
typedef Derived::Type	Type

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

Compute the sum of the variable V.

Definition at line 219 of file STK_Stat_Functors.h.

Member Typedef Documentation

◆ Type

template<class Derived >

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

Definition at line 221 of file STK_Stat_Functors.h.

Constructor & Destructor Documentation

◆ SumOp()

template<class Derived >

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

inline

constructor

Definition at line 223 of file STK_Stat_Functors.h.

223 : V_(V.asDerived())

224 { STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);}

STK_STATIC_ASSERT_ONE_DIMENSION_ONLY

#define STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(EXPR)

Definition STK_StaticAssert.h:151

STK::Stat::SumOp::V_

Derived const & V_

Definition STK_Stat_Functors.h:248

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

Member Function Documentation

◆ operator()() [1/2]

template<class Derived >

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

inline

Returns: the sum of the variable V
$\sum_{i=1}^n V(i)$

Definition at line 228 of file STK_Stat_Functors.h.

    {
      Type sum  = 0.;
      for (int i=V_.begin(); i<V_.end(); i++) { sum += V_[i];}
      return sum;
    }

References STK::Stat::sum(), and STK::Stat::SumOp< Derived >::V_.

◆ operator()() [2/2]

template<class Derived >

template<class Weights >

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

inline

Returns: the weighted sum of the variable V
$\hat{\mu} = \sum_{i=1}^n w(i) V(i).$

Parameters

w	the weights

Definition at line 239 of file STK_Stat_Functors.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Weights);
      // sum the weighted samples
      Type sum  = 0.0;
      for (int i=V_.begin(); i<V_.end(); i++) { sum += w[i] * V_[i];}
      return sum;
    }