Compute the maximal value of the variable V. More...

#include <STK_Stat_Functors.h>

Public Types
typedef Derived::Type	Type

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

Compute the maximal value of the variable V.

Definition at line 148 of file STK_Stat_Functors.h.

Member Typedef Documentation

◆ Type

template<class Derived >

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

Definition at line 150 of file STK_Stat_Functors.h.

Constructor & Destructor Documentation

◆ MaxOp()

template<class Derived >

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

inline

constructor

Definition at line 152 of file STK_Stat_Functors.h.

152 : V_(V.asDerived())

153 { 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::MaxOp::V_

Derived const & V_

Definition STK_Stat_Functors.h:178

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

Member Function Documentation

◆ operator()() [1/2]

template<class Derived >

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

inline

Returns: the maximal value of the variable V
$\max_{i=1}^n v_i$

Definition at line 157 of file STK_Stat_Functors.h.

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

References STK::Stat::max(), and STK::Stat::MaxOp< Derived >::V_.

◆ operator()() [2/2]

template<class Derived >

template<class Weights >

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

inline

Returns: the weighted maximal value of the variable V
$\max_{i=1}^n w_i v_i$

Parameters

w	the weights

Definition at line 169 of file STK_Stat_Functors.h.

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