JMATH::JSqrt< _vF > Struct Reference

Square root of x. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSqrt< _vF >:

Public Member Functions
	JSqrt ()
	Default constructor.
double	getValue (const double x) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
const JSqrt &	getGradient (const double x) const
	Get gradient.
double	operator() (const Args &...args) const
	Function value.
JSqrt< _vF > &	negate ()
	Negate function.
JSqrt< _vF > &	add (const JSqrt< _vF > &f1)
	Add function.
JSqrt< _vF > &	sub (const JSqrt< _vF > &f1)
	Subtract function.
JSqrt< _vF > &	mul (const double factor)
	Scale function.
JSqrt< _vF > &	div (const double factor)
	Scale function.

Static Public Attributes
static const parameter_list< JSqrt >	parameters
	parameters

Detailed Description

Square root of x.

Definition at line 2146 of file JMathlib.hh.

Constructor & Destructor Documentation

JSqrt()

JMATH::JSqrt< _vF >::JSqrt ( )

inline

Default constructor.

Definition at line 2156 of file JMathlib.hh.

    {}

Member Function Documentation

getValue()

double JMATH::JSqrt< _vF >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2166 of file JMathlib.hh.

    {
      return sqrt(x);
    }

getDerivative()

double JMATH::JSqrt< _vF >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2178 of file JMathlib.hh.

    {
      return 0.5 / sqrt(x);
    }

getGradient()

const JSqrt & JMATH::JSqrt< _vF >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2190 of file JMathlib.hh.

    {
      static JSqrt gradient;
 
      return gradient;
    }

operator()()

double JMATH::JMathlib< JSqrt< _vF > >::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...);
    }

negate()

JSqrt< _vF > & JMATH::JCalculus< JSqrt< _vF > >::negate ( )

inlineinherited

Negate function.

Returns

this function

Definition at line 203 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i = -(static_cast<JF1_t&>(*this).*i);
      }
 
      return static_cast<JF1_t&>(*this);
    }

add()

JSqrt< _vF > & JMATH::JCalculus< JSqrt< _vF > >::add ( const JSqrt< _vF > & f1 )

inlineinherited

Add function.

Parameters

f1

function

Returns

this function

Definition at line 219 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i += f1.*i;
      }
 
      return static_cast<JF1_t&>(*this);
    }

sub()

JSqrt< _vF > & JMATH::JCalculus< JSqrt< _vF > >::sub ( const JSqrt< _vF > & f1 )

inlineinherited

Subtract function.

Parameters

f1

function

Returns

this function

Definition at line 235 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i -= f1.*i;
      }
 
      return static_cast<JF1_t&>(*this);
    }

mul()

JSqrt< _vF > & JMATH::JCalculus< JSqrt< _vF > >::mul ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 251 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i *= factor;
      }
 
      return static_cast<JF1_t&>(*this);
    }

div()

JSqrt< _vF > & JMATH::JCalculus< JSqrt< _vF > >::div ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 267 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i /= factor;
      }
 
      return static_cast<JF1_t&>(*this);
    }

Member Data Documentation

parameters

const parameter_list<JSqrt> JMATH::JSqrt< _vF >::parameters

static

parameters

Definition at line 2197 of file JMathlib.hh.

---

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

• JMathlib.hh