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

Recursive template class for polynomial function. More...

#include <JMathlib.hh>

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

Public Member Functions
	JPolynome ()
	Default constructor.
template<class ... Args>
	JPolynome (const Args &...args)
	Constructor.
double	getValue (const double x) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
const JPolynome &	getGradient (const double x) const
	Get gradient.
	JPolynome ()
	Default constructor.
	JPolynome (const JPolynome_t &polynome)
	Copy constructor.
template<class T >
	JPolynome (T __begin, T __end)
	Constructor.
template<class ... Args>
	JPolynome (const Args &...args)
	Initialise constructor.
template<class ... Args>
JPolynome &	set (const Args &...args)
	Set values.
double	getValue (const double x) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
double	getIntegral (const double x) const
	Integral value.
double	operator() (const double x) const
	Function value.
JPolynome	getDerivative () const
	Get derivative function.
JPolynome	getIntegral () const
	get integral function.
JPolynome_t	getGradient (const double x) const
	Get gradient.
double	operator() (const Args &...args) const
	Function value.
JPolynome< ID_t, N > &	negate ()
	Negate function.
JPolynome< ID_t, N > &	add (const JPolynome< ID_t, N > &f1)
	Add function.
JPolynome< ID_t, N > &	sub (const JPolynome< ID_t, N > &f1)
	Subtract function.
JPolynome< ID_t, N > &	mul (const double factor)
	Scale function.
JPolynome< ID_t, N > &	div (const double factor)
	Scale function.
bool	equals (const JPolynome_t &P, const double eps=std::numeric_limits< double >::min()) const
	Equality.
JPolynome_t &	add (const JPolynome_t &polynome)
	Add polynome.
JPolynome_t &	sub (const JPolynome_t &polynome)
	Subtract polynome.
JPolynome_t &	mul (const double factor)
	Scale polynome.
JPolynome_t &	mul (const JSecond_t &object)
	Multiply with object.

Public Attributes
double	a
	a[N]

Static Public Attributes
static const int	ID = ID_t
static const size_t	NUMBER_OF_DEGREES = N
static const parameter_list< JPolynome >	parameters
	parameters

Protected Member Functions
void	set (const double *pA)
	Set parameter values.

Private Member Functions
template<class ... Args>
void	__set__ (const double x, const Args &...args)
	Recursive method for setting values.
void	__set__ () const
	Termination method for setting values.

Detailed Description

template<int ID_t, size_t N>
struct JMATH::JPolynome< ID_t, N >

Recursive template class for polynomial function.

Polynome function object.

Evaluates function, derivative, integral and gradient values.

Definition at line 163 of file JPolynome.hh.

Constructor & Destructor Documentation

JPolynome() [1/6]

template<int ID_t, size_t N>

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

inline

Default constructor.

Definition at line 1397 of file JMathlib.hh.

                :
      a(0.0)
    {}

JPolynome() [2/6]

template<int ID_t, size_t N>

template<class ... Args>

JMATH::JPolynome< ID_t, N >::JPolynome ( const Args &... args )

inline

Constructor.

Parameters

args	list of values

Definition at line 1408 of file JMathlib.hh.

                                   :
      JPolynome()
    {
      set(make_carray(args...));
    }

JPolynome() [3/6]

template<int ID_t, size_t N>

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

inline

Default constructor.

Definition at line 169 of file JPolynome.hh.

    {}

JPolynome() [4/6]

template<int ID_t, size_t N>

JMATH::JPolynome< ID_t, N >::JPolynome ( const JPolynome_t & polynome )

inline

Copy constructor.

Parameters

polynome

polynome

Definition at line 178 of file JPolynome.hh.

                                           :
      JPolynome_t(polynome)
    {}

JPolynome() [5/6]

template<int ID_t, size_t N>

template<class T >

JMATH::JPolynome< ID_t, N >::JPolynome ( T __begin, T __end )

inline

Constructor.

Parameters

__begin	begin of data
__end	end of data

Definition at line 190 of file JPolynome.hh.

    {
      for (T i = __begin; i != __end; ++i) {
        push_back(*i);
      }
    }

JPolynome() [6/6]

template<int ID_t, size_t N>

template<class ... Args>

JMATH::JPolynome< ID_t, N >::JPolynome ( const Args &... args )

inline

Initialise constructor.

Parameters

args

values

Definition at line 205 of file JPolynome.hh.

    {
      set(args...);
    }

Member Function Documentation

getValue() [1/2]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 1421 of file JMathlib.hh.

    {
      return  a * pow(x,N)  +  static_cast<const JPolynome<ID_t, N - 1>&>(*this).getValue(x); 
    }

getDerivative() [1/3]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 1433 of file JMathlib.hh.

    {
      return  N * a * pow(x,N-1)  +  static_cast<const JPolynome<ID_t, N - 1>&>(*this).getDerivative(x); 
    }

getGradient() [1/2]

template<int ID_t, size_t N>

const JPolynome & JMATH::JPolynome< ID_t, N >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 1445 of file JMathlib.hh.

    {
      static JPolynome gradient;                              // d(f)/d(a)
 
      gradient.a = pow(x,N);
      
      static_cast<JPolynome<ID_t, N - 1>&>(gradient) = static_cast<const JPolynome<ID_t, N - 1>&>(*this).getGradient(x);
 
      return gradient;
    }

set() [1/2]

template<int ID_t, size_t N>

void JMATH::JPolynome< ID_t, N >::set ( const double * pA )

inlineprotected

Set parameter values.

Parameters

pA	pointer to list of values

Definition at line 1465 of file JMathlib.hh.

    {
      a = pA[N];
 
      JPolynome<ID_t, N-1>::set(pA);
    }

set() [2/2]

template<int ID_t, size_t N>

template<class ... Args>

JPolynome & JMATH::JPolynome< ID_t, N >::set ( const Args &... args )

inline

Set values.

Parameters

args

values

Definition at line 217 of file JPolynome.hh.

    {
      clear();
 
      __set__(args...);
 
      return *this;
    }

getValue() [2/2]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 233 of file JPolynome.hh.

    {
      double y = 0.0;
      double z = 1.0;
 
      for (const_iterator i = begin(); i != end(); ++i, z *= x) {
        y += (*i) * z;
      }
 
      return y;
    }

getDerivative() [2/3]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 252 of file JPolynome.hh.

    {
      double y = 0.0;
 
      if (!empty()) {
 
        double z = 1.0;
        int    n = 1;
 
        for (const_iterator i = begin(); ++i != end(); ++n, z *= x) {
          y += (*i) * z * n;
        }
      }
 
      return y;
    }

getIntegral() [1/2]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::getIntegral ( const double x ) const

inline

Integral value.

Parameters

x	abscissa value

Returns

integral value

Definition at line 276 of file JPolynome.hh.

    {
      double y = 0.0;
      double z = x;
      int    n = 1;
 
      for (const_iterator i = begin(); i != end(); ++i, ++n, z *= x) {
        y += (*i) * z / n;
      }
 
      return y;
    }

operator()() [1/2]

template<int ID_t, size_t N>

double JMATH::JPolynome< ID_t, N >::operator() ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 296 of file JPolynome.hh.

    {
      return getValue(x);
    }

getDerivative() [3/3]

template<int ID_t, size_t N>

JPolynome JMATH::JPolynome< ID_t, N >::getDerivative ( ) const

inline

Get derivative function.

Returns

derivative function

Definition at line 307 of file JPolynome.hh.

    {
      JPolynome buffer;
 
      if        (size() == 0u) {
      } else if (size() == 1u) {
 
        buffer.push_back(0.0);
 
      } else {
 
        int n = 1;
 
        for (const_iterator i = begin(); ++i != end(); ++n) {
          buffer.push_back(n * (*i));
        }
      }
 
      return buffer;
    }

getIntegral() [2/2]

template<int ID_t, size_t N>

JPolynome JMATH::JPolynome< ID_t, N >::getIntegral ( ) const

inline

get integral function.

Returns

integral function

Definition at line 334 of file JPolynome.hh.

    {
      JPolynome buffer(0.0);
 
      int n = 1;
 
      for (const_iterator i = begin(); i != end(); ++i, ++n) {
        buffer.push_back((*i) / (double) n);
      }
 
      return buffer;
    }

getGradient() [2/2]

template<int ID_t, size_t N>

JPolynome_t JMATH::JPolynome< ID_t, N >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 354 of file JPolynome.hh.

    {
      JPolynome_t buffer;
 
      double z = 1.0;
 
      for (const_iterator i = begin(); i != end(); ++i, z *= x) {
        buffer.push_back(z);                                        // d(f)/d(x_i)
      }
 
      return buffer;
    }

__set__() [1/2]

template<int ID_t, size_t N>

template<class ... Args>

void JMATH::JPolynome< ID_t, N >::__set__ ( const double x, const Args &... args )

inlineprivate

Recursive method for setting values.

Parameters

x	next value
args	remaining values

Definition at line 375 of file JPolynome.hh.

    {
      this->push_back(x);
 
      __set__(args...);
    }

__set__() [2/2]

template<int ID_t, size_t N>

void JMATH::JPolynome< ID_t, N >::__set__ ( ) const

inlineprivate

Termination method for setting values.

Definition at line 386 of file JPolynome.hh.

    {}    

operator()() [2/2]

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

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 362 of file JMathlib.hh.

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

negate()

JPolynome< ID_t, N > & JMATH::JCalculus< JPolynome< ID_t, N > >::negate ( )

inlineinherited

Negate function.

Returns

this function

Definition at line 203 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() [1/2]

JPolynome< ID_t, N > & JMATH::JCalculus< JPolynome< ID_t, N > >::add ( const JPolynome< ID_t, N > & f1 )

inlineinherited

Add function.

Parameters

f1

function

Returns

this function

Definition at line 219 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() [1/2]

JPolynome< ID_t, N > & JMATH::JCalculus< JPolynome< ID_t, N > >::sub ( const JPolynome< ID_t, N > & f1 )

inlineinherited

Subtract function.

Parameters

f1

function

Returns

this function

Definition at line 235 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() [1/3]

JPolynome< ID_t, N > & JMATH::JCalculus< JPolynome< ID_t, N > >::mul ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 251 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, N > & JMATH::JCalculus< JPolynome< ID_t, N > >::div ( const double factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 267 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i /= factor;
      }
 
      return static_cast<JF1_t&>(*this);
    }

equals()

bool JMATH::JPolynome_t::equals ( const JPolynome_t & P, const double eps = std::numeric_limits<double>::min() ) const

inlineinherited

Equality.

Parameters

P	polynome
eps	numerical precision

Returns

true if polynomes identical; else false

Definition at line 47 of file JPolynome.hh.

    {
      if (this->size() == P.size()) {
 
        for (const_iterator p = this->begin(), q = P.begin(); p != this->end(); ++p, ++q) {
          if (fabs(*p - *q) > eps) {
            return false;
          }
        }
 
        return true;
        
      } else {
 
        return false;
      }
    }

add() [2/2]

JPolynome_t & JMATH::JPolynome_t::add ( const JPolynome_t & polynome )

inlineinherited

Add polynome.

Parameters

polynome

polynome

Returns

this polynome

Definition at line 73 of file JPolynome.hh.

    {
      while (this->size() < polynome.size()) {
        this->push_back(0.0);
      }
 
      for (size_t i = 0; i != this->size(); ++i) {
        (*this)[i] += polynome[i];
      }
 
      return *this;
    }

sub() [2/2]

JPolynome_t & JMATH::JPolynome_t::sub ( const JPolynome_t & polynome )

inlineinherited

Subtract polynome.

Parameters

polynome

polynome

Returns

this polynome

Definition at line 93 of file JPolynome.hh.

    {
      while (this->size() < polynome.size()) {
        this->push_back(0.0);
      }
 
      for (size_t i = 0; i != this->size(); ++i) {
        (*this)[i] -= polynome[i];
      }
 
      return *this;
    }

mul() [2/3]

JPolynome_t & JMATH::JPolynome_t::mul ( const double factor )

inlineinherited

Scale polynome.

Parameters

factor

multiplication factor

Returns

this polynome

Definition at line 113 of file JPolynome.hh.

    {
      for (iterator i = begin(); i != end(); ++i) {
        (*i) *= factor;
      }
 
      return *this;
    }

mul() [3/3]

JPolynome_t & JMATH::JMath< JPolynome_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

ID

template<int ID_t, size_t N>

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

static

Definition at line 1382 of file JMathlib.hh.

NUMBER_OF_DEGREES

template<int ID_t, size_t N>

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

static

Definition at line 1384 of file JMathlib.hh.

a

template<int ID_t, size_t N>

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

a[N]

Definition at line 1456 of file JMathlib.hh.

parameters

template<int ID_t, size_t N>

const parameter_list< JPolynome< ID_t, N > > JMATH::JPolynome< ID_t, N >::parameters

static

parameters

Set parameters.

Definition at line 1457 of file JMathlib.hh.

---

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

• JMathlib.hh
• JPolynome.hh