JMATH::JPolynome Struct Reference

Polynome function object. More...

#include <JPolynome.hh>

Inheritance diagram for JMATH::JPolynome:

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

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

Detailed Description

Polynome function object.

Evaluates function, derivative, integral and gradient values.

Definition at line 163 of file JPolynome.hh.

Constructor & Destructor Documentation

JMATH::JPolynome::JPolynome ( )

inline

Default constructor.

Definition at line 169 of file JPolynome.hh.

    {}

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

inline

Copy constructor.

Parameters

polynome

polynome

Definition at line 178 of file JPolynome.hh.

                                           :
      JPolynome_t(polynome)
    {}

template<class T >

JMATH::JPolynome::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);
      }
    }

template<class... Args>

JMATH::JPolynome::JPolynome ( const Args &...  args )

inline

Initialise constructor.

Parameters

args

values

Definition at line 205 of file JPolynome.hh.

    {
      set(args...);
    }

Member Function Documentation

template<class... Args>

JPolynome& JMATH::JPolynome::set ( const Args &...  args )

inline

Set values.

Parameters

args

values

Definition at line 217 of file JPolynome.hh.

    {
      clear();

      __set__(args...);

      return *this;
    }

double JMATH::JPolynome::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;
    }

double JMATH::JPolynome::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;
    }

double JMATH::JPolynome::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;
    }

double JMATH::JPolynome::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);
    }

JPolynome JMATH::JPolynome::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;
    }

JPolynome JMATH::JPolynome::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;
    }

JPolynome_t JMATH::JPolynome::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;
    }

template<class... Args>

void JMATH::JPolynome::__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...);
    }

void JMATH::JPolynome::__set__ ( ) const

inlineprivate

Termination method for setting values.

Definition at line 386 of file JPolynome.hh.

    {}    

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;
      }
    }

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;
    }

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;
    }

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;
    }

JPolynome_t & JMATH::JMath< JPolynome_t , JNullType >::mul ( const JNullType &  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);
    }

---

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

• JPolynome.hh