JMATH::JSub< JF1_t, double > Struct Template Reference

Subtraction of constant value. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSub< JF1_t, double >:

Public Member Functions
	JSub ()
	Default constructor.
	JSub (const JF1_t &f1, const double value)
	Constructor.
template<class ... Args>
double	getValue (const Args &...args) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
template<class ... Args>
JSub	getGradient (const Args &...args) const
	Get gradient.
double	operator() (const Args &...args) const
	Function value.
double	operator[] (const size_t i) const
	Get value of parameter at given index.
double &	operator[] (const size_t i)
	Get value of parameter at given index.

Static Public Member Functions
static size_t	size ()
	Get size of parameter.

Private Attributes
double	value

Detailed Description

template<class JF1_t>
struct JMATH::JSub< JF1_t, double >

Subtraction of constant value.

Definition at line 723 of file JMathlib.hh.

Constructor & Destructor Documentation

JSub() [1/2]

template<class JF1_t >

JMATH::JSub< JF1_t, double >::JSub ( )

inline

Default constructor.

Definition at line 734 of file JMathlib.hh.

    {}

JSub() [2/2]

template<class JF1_t >

JMATH::JSub< JF1_t, double >::JSub ( const JF1_t & f1, const double value )

inline

Constructor.

Parameters

f1	function
value	value

Definition at line 744 of file JMathlib.hh.

                                              :
      JF1_t(f1),
      value(value)
    {}

Member Function Documentation

getValue()

template<class JF1_t >

template<class ... Args>

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

inline

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 757 of file JMathlib.hh.

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

getDerivative()

template<class JF1_t >

double JMATH::JSub< JF1_t, double >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 769 of file JMathlib.hh.

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

getGradient()

template<class JF1_t >

template<class ... Args>

JSub JMATH::JSub< JF1_t, double >::getGradient ( const Args &... args ) const

inline

Get gradient.

Parameters

args	abscissa value(s)

Returns

gradient

Definition at line 782 of file JMathlib.hh.

    {
      JSub gradient;
 
      static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
 
      return gradient;
    }

operator()()

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

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 331 of file JMathlib.hh.

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

size()

static size_t JMATH::JMathlib< JF1_t >::size ( )

inlinestaticinherited

Get size of parameter.

Returns

size

Definition at line 538 of file JMathlib.hh.

    {
      return JF1_t::parameters.size();
    }

operator[]() [1/2]

double JMATH::JMathlib< JF1_t >::operator[] ( const size_t i ) const

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 550 of file JMathlib.hh.

    {
      return static_cast<const JF1_t&>(*this).*JF1_t::parameters[i];
    }

operator[]() [2/2]

double & JMATH::JMathlib< JF1_t >::operator[] ( const size_t i )

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 562 of file JMathlib.hh.

    {
      return static_cast<JF1_t&>(*this).*JF1_t::parameters[i];
    }

Member Data Documentation

value

template<class JF1_t >

double JMATH::JSub< JF1_t, double >::value

private

Definition at line 792 of file JMathlib.hh.

---

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

• JMathlib.hh