JMATH::JGauss< ID_t, true > Struct Template Reference

Gauss function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JGauss< ID_t, true >:

Public Member Functions
	JGauss ()
	Default constructor.
	JGauss (const double center, const double sigma)
	Constructor.
double	getValue (const double x) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
JGauss	getGradient (const double x) 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.
JGauss< ID_t, true > &	negate ()
	Negate function.
JGauss< ID_t, true > &	add (const JGauss< ID_t, true > &f1)
	Add function.
JGauss< ID_t, true > &	sub (const JGauss< ID_t, true > &f1)
	Subtract function.
JGauss< ID_t, true > &	mul (const double factor)
	Scale function.
JGauss< ID_t, true > &	div (const double factor)
	Scale function.

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

Public Attributes
double	center
	center
double	sigma
	sigma

Static Public Attributes
static const int	ID = ID_t
static constexpr parameter_list< JGauss, 2 >	parameters { &JGauss::center, &JGauss::sigma }

Private Member Functions
double	get (const double u) const
	Get ordinate value.

Detailed Description

template<int ID_t>
struct JMATH::JGauss< ID_t, true >

Gauss function.

Definition at line 2098 of file JMathlib.hh.

Constructor & Destructor Documentation

JGauss() [1/2]

template<int ID_t>

JMATH::JGauss< ID_t, true >::JGauss ( )

inline

Default constructor.

Definition at line 2108 of file JMathlib.hh.

             :
      center(0.0),
      sigma (0.0)
    {}

JGauss() [2/2]

template<int ID_t>

JMATH::JGauss< ID_t, true >::JGauss ( const double center, const double sigma )

inline

Constructor.

Parameters

center	center
sigma	sigma

Definition at line 2120 of file JMathlib.hh.

                               :
      center(center),
      sigma (sigma)
    {}

Member Function Documentation

getValue()

template<int ID_t>

double JMATH::JGauss< ID_t, true >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2133 of file JMathlib.hh.

    {
      const double u  = (x - center) / sigma;
 
      return get(u);
    }

getDerivative()

template<int ID_t>

double JMATH::JGauss< ID_t, true >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2147 of file JMathlib.hh.

    {
      const double w  = 1.0 / sigma;
      const double u  = (x - center) / sigma;
 
      return get(u) * -u * w;
    }

getGradient()

template<int ID_t>

JGauss JMATH::JGauss< ID_t, true >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2162 of file JMathlib.hh.

    {
      JGauss gradient;
 
      const double w  = 1.0 / sigma;
      const double u  = (x - center) * w;
      const double f0 =  get(u);
 
      gradient.center =  f0 * (u)                   * w;      // d(f)/d(center)
      gradient.sigma  =  f0 * (u + 1.0) * (u - 1.0) * w;      // d(f)/d(sigma)
 
      return gradient;
    }

get()

template<int ID_t>

double JMATH::JGauss< ID_t, true >::get ( const double u ) const

inlineprivate

Get ordinate value.

Parameters

u	abscissa value

Returns

ordinate value

Definition at line 2188 of file JMathlib.hh.

    {
      static const double W = 1.0 / sqrt(2.0 * acos(-1.0));
 
      return exp(-0.5*u*u) * W / sigma;
    }

operator()()

double JMATH::JMathlib< JGauss< ID_t, true > >::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< JGauss< ID_t, true > >::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< JGauss< ID_t, true > >::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< JGauss< ID_t, true > >::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];
    }

negate()

JGauss< ID_t, true > & JMATH::JCalculus< JGauss< ID_t, true > >::negate ( )

inlineinherited

Negate function.

Returns

this function

Definition at line 170 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()

JGauss< ID_t, true > & JMATH::JCalculus< JGauss< ID_t, true > >::add ( const JGauss< ID_t, true > & f1 )

inlineinherited

Add function.

Parameters

f1

function

Returns

this function

Definition at line 186 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()

JGauss< ID_t, true > & JMATH::JCalculus< JGauss< ID_t, true > >::sub ( const JGauss< ID_t, true > & f1 )

inlineinherited

Subtract function.

Parameters

f1

function

Returns

this function

Definition at line 202 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()

JGauss< ID_t, true > & JMATH::JCalculus< JGauss< ID_t, true > >::mul ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 218 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()

JGauss< ID_t, true > & JMATH::JCalculus< JGauss< ID_t, true > >::div ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

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

ID

template<int ID_t>

const int JMATH::JGauss< ID_t, true >::ID = ID_t

static

Definition at line 2102 of file JMathlib.hh.

center

template<int ID_t>

double JMATH::JGauss< ID_t, true >::center

center

Definition at line 2176 of file JMathlib.hh.

sigma

template<int ID_t>

double JMATH::JGauss< ID_t, true >::sigma

sigma

Definition at line 2177 of file JMathlib.hh.

parameters

template<int ID_t>

parameter_list<JGauss, 2> JMATH::JGauss< ID_t, true >::parameters { &JGauss::center, &JGauss::sigma }

staticconstexpr

Definition at line 2179 of file JMathlib.hh.

{ &JGauss::center, &JGauss::sigma };

---

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

• JMathlib.hh