Jpp 20.0.0-27-g39925593c-D
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
JMATH::JSqrt< _vF > Struct Reference

Square root of x. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSqrt< _vF >:
JMATH::JMathlib< JSqrt< _vF > > JMATH::JCalculus< 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 JSqrtgetGradient (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< JSqrtparameters
 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.

2157 {}

Member Function Documentation

◆ getValue()

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

Function value.

Parameters
xabscissa value
Returns
function value

Definition at line 2166 of file JMathlib.hh.

2167 {
2168 return sqrt(x);
2169 }

◆ getDerivative()

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

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 2178 of file JMathlib.hh.

2179 {
2180 return 0.5 / sqrt(x);
2181 }

◆ getGradient()

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

Get gradient.

Parameters
xabscissa value
Returns
gradient

Definition at line 2190 of file JMathlib.hh.

2191 {
2192 static JSqrt gradient;
2193
2194 return gradient;
2195 }
JSqrt()
Default constructor.
Definition JMathlib.hh:2156

◆ operator()()

double JMATH::JMathlib< JSqrt< _vF > >::operator() ( const Args &... args) const
inlineinherited

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 362 of file JMathlib.hh.

◆ negate()

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

Negate function.

Returns
this function

Definition at line 203 of file JMathlib.hh.

◆ add()

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

Add function.

Parameters
f1function
Returns
this function

Definition at line 219 of file JMathlib.hh.

◆ sub()

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

Subtract function.

Parameters
f1function
Returns
this function

Definition at line 235 of file JMathlib.hh.

◆ mul()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 251 of file JMathlib.hh.

◆ div()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 267 of file JMathlib.hh.

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: