gum::Minimizes< GUM_SCALAR > Struct Template Reference

Minimization function object class. More...

#include <agrum/base/core/functors.h>

Public Types
using	first_argument_type = GUM_SCALAR
using	second_argument_type = GUM_SCALAR
using	result_type = GUM_SCALAR

Public Member Functions
Operator()
GUM_SCALAR	operator() (const GUM_SCALAR &x, const GUM_SCALAR &y) const

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 99 of file functors.h.

Member Typedef Documentation

first_argument_type

template<class GUM_SCALAR>

using gum::Minimizes< GUM_SCALAR >::first_argument_type = GUM_SCALAR

Definition at line 109 of file functors.h.

result_type

template<class GUM_SCALAR>

using gum::Minimizes< GUM_SCALAR >::result_type = GUM_SCALAR

Definition at line 111 of file functors.h.

second_argument_type

template<class GUM_SCALAR>

using gum::Minimizes< GUM_SCALAR >::second_argument_type = GUM_SCALAR

Definition at line 110 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

Definition at line 54 of file functors_tpl.h.

                                                                                               {
    return x <= y ? x : y;
  }

---

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

• agrum/base/core/functors.h
• agrum/base/core/functors_tpl.h