STK::MinWithOp< Type > Struct Template Reference

Template functor to compute the minimum between a fixed value. More...

#include <STK_Functors.h>

Public Types
enum	{ NbParam_ = 1 }
typedef Type	result_type
typedef hidden::RemoveConst< Type >::Type	param1_type

Public Member Functions
	MinWithOp (Type const &value)
	MinWithOp (MinWithOp const &value)
result_type	operator() (param1_type const &a) const

Private Attributes
param1_type const	value_

Detailed Description

template<typename Type>
struct STK::MinWithOp< Type >

Template functor to compute the minimum between a fixed value.

Definition at line 658 of file STK_Functors.h.

Member Typedef Documentation

param1_type

template<typename Type >

typedef hidden::RemoveConst<Type>::Type STK::MinWithOp< Type >::param1_type

Definition at line 662 of file STK_Functors.h.

result_type

template<typename Type >

typedef Type STK::MinWithOp< Type >::result_type

Definition at line 661 of file STK_Functors.h.

Member Enumeration Documentation

anonymous enum

template<typename Type >

anonymous enum

Enumerator
NbParam_

Definition at line 660 of file STK_Functors.h.

{ NbParam_ = 1 };

Constructor & Destructor Documentation

MinWithOp() [1/2]

template<typename Type >

STK::MinWithOp< Type >::MinWithOp ( Type const &  value )

inline

Definition at line 664 of file STK_Functors.h.

: value_(value) {}

MinWithOp() [2/2]

template<typename Type >

STK::MinWithOp< Type >::MinWithOp ( MinWithOp< Type > const &  value )

inline

Definition at line 665 of file STK_Functors.h.

: value_(value.value_) {}

Member Function Documentation

operator()()

template<typename Type >

result_type STK::MinWithOp< Type >::operator() ( param1_type const &  a ) const

inline

Definition at line 667 of file STK_Functors.h.

{return std::min(a,value_);}

References STK::MinWithOp< Type >::value_.

Member Data Documentation

value_

template<typename Type >

param1_type const STK::MinWithOp< Type >::value_

private

Definition at line 669 of file STK_Functors.h.

Referenced by STK::MinWithOp< Type >::operator()().

---

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

• STK_Functors.h