aGrUM  0.16.0
gum::Minimizes< GUM_SCALAR > Struct Template Reference

Minimization function object classReturns the minimum of its two arguments. More...

#include <agrum/core/functors.h>

Public Member Functions

Operator()
GUM_SCALAR operator() (const GUM_SCALAR &x, const GUM_SCALAR &y) const
 

Public Types

typedef GUM_SCALAR first_argument_type
 
typedef GUM_SCALAR second_argument_type
 
typedef GUM_SCALAR result_type
 

Detailed Description

template<class GUM_SCALAR>
struct gum::Minimizes< GUM_SCALAR >

Minimization function object class

Returns the minimum of its two arguments.

Definition at line 81 of file functors.h.

Member Typedef Documentation

◆ first_argument_type

template<class GUM_SCALAR >
typedef GUM_SCALAR gum::Minimizes< GUM_SCALAR >::first_argument_type

Definition at line 93 of file functors.h.

◆ result_type

template<class GUM_SCALAR >
typedef GUM_SCALAR gum::Minimizes< GUM_SCALAR >::result_type

Definition at line 95 of file functors.h.

◆ second_argument_type

template<class GUM_SCALAR >
typedef GUM_SCALAR gum::Minimizes< GUM_SCALAR >::second_argument_type

Definition at line 94 of file functors.h.

Member Function Documentation

◆ operator()()

template<class GUM_SCALAR >
GUM_SCALAR gum::Minimizes< GUM_SCALAR >::operator() ( const GUM_SCALAR &  x,
const GUM_SCALAR &  y 
) const
inline

Definition at line 87 of file functors.h.

87  {
88  return x <= y ? x : y;
89  }

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