JMATH::JXn< N > Struct Template Reference

Function object for x;. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JXn< N >:

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

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

Detailed Description

template<int N>
struct JMATH::JXn< N >

Function object for x;.

Fixed power of x.

Definition at line 1558 of file JMathlib.hh.

Constructor & Destructor Documentation

JXn()

template<int N>

JMATH::JXn< N >::JXn ( )

inline

Default constructor.

Definition at line 1565 of file JMathlib.hh.

    {}

Member Function Documentation

getValue()

template<int N>

double JMATH::JXn< N >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 1575 of file JMathlib.hh.

    {
      return pow(x, N);
    }

getDerivative()

template<int N>

double JMATH::JXn< N >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 1587 of file JMathlib.hh.

    {
      return N * pow(x, N - 1);
    }

getGradient()

template<int N>

JXn JMATH::JXn< N >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 1599 of file JMathlib.hh.

    {
      JXn gradient;
 
      return gradient;
    }

operator()()

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

operator[]() [1/2]

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

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 539 of file JMathlib.hh.

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

operator[]() [2/2]

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

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 551 of file JMathlib.hh.

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

negate()

JXn< N > & JMATH::JCalculus< JXn< N > >::negate ( )

inlineinherited

Negate function.

Returns

this function

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

JXn< N > & JMATH::JCalculus< JXn< N > >::add ( const JXn< N > & f1 )

inlineinherited

Add function.

Parameters

f1

function

Returns

this function

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

JXn< N > & JMATH::JCalculus< JXn< N > >::sub ( const JXn< N > & f1 )

inlineinherited

Subtract function.

Parameters

f1

function

Returns

this function

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

JXn< N > & JMATH::JCalculus< JXn< N > >::mul ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

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

JXn< N > & JMATH::JCalculus< JXn< N > >::div ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

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

template<int N>

parameter_list<JXn, 0> JMATH::JXn< N >::parameters {}

staticconstexpr

Definition at line 1606 of file JMathlib.hh.

{};

---

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

• JMathlib.hh