JMATH::JNegate< JF1_t > Struct Template Reference

Negate of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JNegate< JF1_t >:

Public Member Functions
	JNegate ()
	Default constructor. More...
	JNegate (const JF1_t &f1)
	Constructor. More...
template<class... Args>
double	getValue (const Args &...args) const
	Function value. More...
double	getDerivative (const double x) const
	Derivative value. More...
template<class... Args>
const JNegate &	getGradient (const Args &...args) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...

Detailed Description

template<class JF1_t>
struct JMATH::JNegate< JF1_t >

Negate of function.

Definition at line 331 of file JMathlib.hh.

Constructor & Destructor Documentation

template<class JF1_t >

JMATH::JNegate< JF1_t >::JNegate ( )

inline

Default constructor.

Definition at line 567 of file JMathlib.hh.

    {}

template<class JF1_t >

JMATH::JNegate< JF1_t >::JNegate ( const JF1_t &  f1 )

inline

Constructor.

Parameters

f1

function

Definition at line 576 of file JMathlib.hh.

                             :
      JF1_t(f1)
    {}

Member Function Documentation

template<class JF1_t >

template<class... Args>

double JMATH::JNegate< JF1_t >::getValue ( const Args &...  args ) const

inline

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 588 of file JMathlib.hh.

    {
      return -static_cast<const JF1_t&>(*this).getValue(args...);
    }

template<class JF1_t >

double JMATH::JNegate< JF1_t >::getDerivative ( const double  x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 600 of file JMathlib.hh.

    {
      return -static_cast<const JF1_t&>(*this).getDerivative(x);
    }

template<class JF1_t >

template<class... Args>

const JNegate& JMATH::JNegate< JF1_t >::getGradient ( const Args &...  args ) const

inline

Get gradient.

Parameters

args	abscissa value(s)

Returns

gradient

Definition at line 613 of file JMathlib.hh.

    {
      static JNegate gradient;

      static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
      static_cast<JF1_t&>(gradient).negate();

      return gradient;
    }

double JMATH::JMathlib< JNegate< JF1_t > >::operator() ( const Args &...  args ) const

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 362 of file JMathlib.hh.

    {
      return static_cast<const JF1_t&>(*this).getValue(args...);
    }

---

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

• JMathlib.hh