STK++ 0.9.13
Public Types | Public Member Functions | Public Attributes | List of all members
STK::hidden::MeanVisitor< Type_ > Struct Template Reference
Hidden implementation details

Visitor computing the mean of all the coefficients of the Array. More...

#include <STK_Visitors.h>

Public Types

typedef Type_ Type
 
typedef RemoveConst< Type >::Type TypeConst
 

Public Member Functions

 MeanVisitor ()
 
void operator() (Type const &value, int i, int j)
 
void operator() (Type const &value, int i)
 
TypeConst result () const
 

Public Attributes

Type res_
 
int nb_
 

Detailed Description

template<typename Type_>
struct STK::hidden::MeanVisitor< Type_ >

Visitor computing the mean of all the coefficients of the Array.

See also
ExprBase::mean()

Definition at line 242 of file STK_Visitors.h.

Member Typedef Documentation

◆ Type

template<typename Type_ >
typedef Type_ STK::hidden::MeanVisitor< Type_ >::Type

Definition at line 244 of file STK_Visitors.h.

◆ TypeConst

template<typename Type_ >
typedef RemoveConst<Type>::Type STK::hidden::MeanVisitor< Type_ >::TypeConst

Definition at line 245 of file STK_Visitors.h.

Constructor & Destructor Documentation

◆ MeanVisitor()

template<typename Type_ >
STK::hidden::MeanVisitor< Type_ >::MeanVisitor ( )
inline

Definition at line 248 of file STK_Visitors.h.

248: res_(Type(0)), nb_(0) {}

Member Function Documentation

◆ operator()() [1/2]

template<typename Type_ >
void STK::hidden::MeanVisitor< Type_ >::operator() ( Type const &  value,
int  i 
)
inline

Definition at line 251 of file STK_Visitors.h.

252 { res_ += value; nb_++;}

References STK::hidden::MeanVisitor< Type_ >::nb_, and STK::hidden::MeanVisitor< Type_ >::res_.

◆ operator()() [2/2]

template<typename Type_ >
void STK::hidden::MeanVisitor< Type_ >::operator() ( Type const &  value,
int  i,
int  j 
)
inline

Definition at line 249 of file STK_Visitors.h.

250 { res_ += value; nb_++;}

References STK::hidden::MeanVisitor< Type_ >::nb_, and STK::hidden::MeanVisitor< Type_ >::res_.

◆ result()

template<typename Type_ >
TypeConst STK::hidden::MeanVisitor< Type_ >::result ( ) const
inline

Definition at line 253 of file STK_Visitors.h.

253{ return nb_ == 0 ? Arithmetic<Type>::NA() : res_/nb_;}
STK::Arithmetic::NA
static Type NA()
Adding a Non Available (NA) special number.
Definition STK_Arithmetic.h:194

References STK::Arithmetic< Type >::NA(), STK::hidden::MeanVisitor< Type_ >::nb_, and STK::hidden::MeanVisitor< Type_ >::res_.

Member Data Documentation

◆ nb_

template<typename Type_ >
int STK::hidden::MeanVisitor< Type_ >::nb_

Definition at line 247 of file STK_Visitors.h.

Referenced by STK::hidden::MeanVisitor< Type_ >::operator()(), STK::hidden::MeanVisitor< Type_ >::operator()(), and STK::hidden::MeanVisitor< Type_ >::result().

◆ res_

template<typename Type_ >
Type STK::hidden::MeanVisitor< Type_ >::res_

Definition at line 246 of file STK_Visitors.h.

Referenced by STK::hidden::MeanVisitor< Type_ >::operator()(), STK::hidden::MeanVisitor< Type_ >::operator()(), and STK::hidden::MeanVisitor< Type_ >::result().

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