JMATH::JCos< JF1_t > Struct Template Reference

Cosine of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JCos< JF1_t >:

Public Member Functions
	JCos ()
	Default constructor.
	JCos (const JF1_t &f1)
	Constructor.
double	getValue (const double x) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
JCos	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.
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.
JX &	negate ()
	Negate function.
JX &	add (const JX &f1)
	Add function.
JX &	sub (const JX &f1)
	Subtract function.
JX &	mul (const double factor)
	Scale function.
JX &	div (const double factor)
	Scale function.

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

Static Public Attributes
static constexpr parameter_list< JX, 0 >	parameters {}

Detailed Description

template<class JF1_t = JX>
struct JMATH::JCos< JF1_t >

Cosine of function.

Definition at line 2501 of file JMathlib.hh.

Constructor & Destructor Documentation

JCos() [1/2]

template<class JF1_t = JX>

JMATH::JCos< JF1_t >::JCos ( )

inline

Default constructor.

Definition at line 2512 of file JMathlib.hh.

           :
      JF1_t()
    {}

JCos() [2/2]

template<class JF1_t = JX>

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

inline

Constructor.

Parameters

f1

function

Definition at line 2522 of file JMathlib.hh.

                          :
      JF1_t(f1)
    {}

Member Function Documentation

getValue()

template<class JF1_t = JX>

double JMATH::JCos< JF1_t >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2533 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
 
      return cos(u);
    }

getDerivative()

template<class JF1_t = JX>

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

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2547 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
      const double v = static_cast<const JF1_t&>(*this).getDerivative(x);
 
      return v * -sin(u);
    }

getGradient()

template<class JF1_t = JX>

JCos JMATH::JCos< JF1_t >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2562 of file JMathlib.hh.

    {
      JCos gradient;
 
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
 
      static_cast<JF1_t&>(gradient)  = static_cast<const JF1_t&>(*this).getGradient(x);
      static_cast<JF1_t&>(gradient) *= -sin(u);
 
      return gradient;
    }

operator()() [1/2]

double JMATH::JMathlib< JCos< JX > >::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() [1/2]

static size_t JMATH::JMathlib< JCos< JX > >::size ( )

inlinestaticinherited

Get size of parameter.

Returns

size

Definition at line 538 of file JMathlib.hh.

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

operator[]() [1/4]

double JMATH::JMathlib< JCos< JX > >::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/4]

double & JMATH::JMathlib< JCos< JX > >::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];
    }

operator()() [2/2]

double JMATH::JMathlib< JX >::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() [2/2]

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

inlinestaticinherited

Get size of parameter.

Returns

size

Definition at line 538 of file JMathlib.hh.

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

operator[]() [3/4]

double JMATH::JMathlib< JX >::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[]() [4/4]

double & JMATH::JMathlib< JX >::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()

JX & JMATH::JCalculus< JX >::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()

JX & JMATH::JCalculus< JX >::add ( const JX & 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()

JX & JMATH::JCalculus< JX >::sub ( const JX & 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()

JX & JMATH::JCalculus< JX >::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()

JX & JMATH::JCalculus< JX >::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

parameters

parameter_list<JX, 0> JMATH::JX::parameters {}

staticconstexprinherited

Definition at line 1599 of file JMathlib.hh.

{};

---

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

• JMathlib.hh