JMATH::JPolynome< ID_t, 0 > Struct Template Reference

Termination class for polynomial function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JPolynome< ID_t, 0 >:

Public Member Functions
	JPolynome ()
	Default constructor.
	JPolynome (const double a)
	Constructor.
	JPolynome (const std::array< double, 1 > &args)
	Constructor.
double	getValue (...) const
	Function value.
double	getDerivative (...) const
	Derivative value.
JPolynome	getGradient (...) 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.
JPolynome< ID_t, 0 > &	negate ()
	Negate function.
JPolynome< ID_t, 0 > &	add (const JPolynome< ID_t, 0 > &f1)
	Add function.
JPolynome< ID_t, 0 > &	sub (const JPolynome< ID_t, 0 > &f1)
	Subtract function.
JPolynome< ID_t, 0 > &	mul (const double factor)
	Scale function.
JPolynome< ID_t, 0 > &	div (const double factor)
	Scale function.

Public Attributes
double	a
	a[0]

Static Public Attributes
static const int	ID = ID_t
static const size_t	NUMBER_OF_DEGREES = 0
static constexpr parameter_list< JPolynome, 1 >	parameters {&JPolynome::a}

Protected Member Functions
void	set (const double x)
	Recursive method for setting values.

Detailed Description

template<int ID_t>
struct JMATH::JPolynome< ID_t, 0 >

Termination class for polynomial function.

This function consititutes a constant term and is thereby multi-dimensional by nature.

Definition at line 1833 of file JMathlib.hh.

Constructor & Destructor Documentation

JPolynome() [1/3]

template<int ID_t>

JMATH::JPolynome< ID_t, 0 >::JPolynome ( )

inline

Default constructor.

Definition at line 1845 of file JMathlib.hh.

                :
      a(0.0)
    {}

JPolynome() [2/3]

template<int ID_t>

JMATH::JPolynome< ID_t, 0 >::JPolynome ( const double a )

inline

Constructor.

Parameters

a

value

Definition at line 1855 of file JMathlib.hh.

                              :
      a(a)
    {}

JPolynome() [3/3]

template<int ID_t>

JMATH::JPolynome< ID_t, 0 >::JPolynome ( const std::array< double, 1 > & args )

inline

Constructor.

Parameters

args	list of values

Definition at line 1865 of file JMathlib.hh.

                                               :
      JPolynome()
    {
      a = std::data(args)[0];
    }

Member Function Documentation

getValue()

template<int ID_t>

double JMATH::JPolynome< ID_t, 0 >::getValue ( ... ) const

inline

Function value.

Returns

function value

Definition at line 1877 of file JMathlib.hh.

    {
      return a;
    }

getDerivative()

template<int ID_t>

double JMATH::JPolynome< ID_t, 0 >::getDerivative ( ... ) const

inline

Derivative value.

Returns

derivative value

Definition at line 1888 of file JMathlib.hh.

    {
      return 0.0;
    }

getGradient()

template<int ID_t>

JPolynome JMATH::JPolynome< ID_t, 0 >::getGradient ( ... ) const

inline

Get gradient.

Returns

gradient

Definition at line 1899 of file JMathlib.hh.

    {
      JPolynome gradient;
 
      gradient.a = 1.0;
 
      return gradient;
    }

set()

template<int ID_t>

void JMATH::JPolynome< ID_t, 0 >::set ( const double x )

inlineprotected

Recursive method for setting values.

Parameters

x

value

Definition at line 1918 of file JMathlib.hh.

    {
      a = x;
    }

operator()()

double JMATH::JMathlib< JPolynome< ID_t, 0 > >::operator() ( const Args &... args ) const

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 330 of file JMathlib.hh.

    {
      return static_cast<const JF1_t&>(*this).getValue(args...);
    }

operator[]() [1/2]

double JMATH::JMathlib< JPolynome< ID_t, 0 > >::operator[] ( const size_t i ) const

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 538 of file JMathlib.hh.

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

operator[]() [2/2]

double & JMATH::JMathlib< JPolynome< ID_t, 0 > >::operator[] ( const size_t i )

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 550 of file JMathlib.hh.

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

negate()

JPolynome< ID_t, 0 > & JMATH::JCalculus< JPolynome< ID_t, 0 > >::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()

JPolynome< ID_t, 0 > & JMATH::JCalculus< JPolynome< ID_t, 0 > >::add ( const JPolynome< ID_t, 0 > & 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()

JPolynome< ID_t, 0 > & JMATH::JCalculus< JPolynome< ID_t, 0 > >::sub ( const JPolynome< ID_t, 0 > & 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()

JPolynome< ID_t, 0 > & JMATH::JCalculus< JPolynome< ID_t, 0 > >::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()

JPolynome< ID_t, 0 > & JMATH::JCalculus< JPolynome< ID_t, 0 > >::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

ID

template<int ID_t>

const int JMATH::JPolynome< ID_t, 0 >::ID = ID_t

static

Definition at line 1837 of file JMathlib.hh.

NUMBER_OF_DEGREES

template<int ID_t>

const size_t JMATH::JPolynome< ID_t, 0 >::NUMBER_OF_DEGREES = 0

static

Definition at line 1839 of file JMathlib.hh.

a

template<int ID_t>

double JMATH::JPolynome< ID_t, 0 >::a

a[0]

Definition at line 1908 of file JMathlib.hh.

parameters

template<int ID_t>

parameter_list<JPolynome, 1> JMATH::JPolynome< ID_t, 0 >::parameters {&JPolynome::a}

staticconstexpr

Definition at line 1910 of file JMathlib.hh.

{&JPolynome::a};

---

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

• JMathlib.hh