JTOOLS::JResultPolynome< N, JResult_t > Struct Template Reference

Data structure for result including value and N derivatives of function. More...

#include <JResult.hh>

Inheritance diagram for JTOOLS::JResultPolynome< N, JResult_t >:

Public Types
typedef JLANG::JClass < JResult_t >::argument_type	argument_type

Public Member Functions
	JResultPolynome ()
	Default constructor. More...
	operator JResultDerivative< JResult_t > () const
	Type conversion operator. More...
	operator JResultHesse< JResult_t > () const
	Type conversion operator. More...
JResultPolynome &	negate ()
	Prefix unary minus for function value of PDF. More...
JResultPolynome &	add (const JResultPolynome &value)
	Addition operator for function value of PDF. More...
JResultPolynome &	sub (const JResultPolynome &value)
	Subtraction operator for function value of PDF. More...
JResultPolynome &	mul (const double value)
	Multiplication operator for function value of PDF. More...
JResultPolynome &	div (const double value)
	Division operator for function value of PDF. More...
double	getValue (const double x) const
	Function value. More...
double	operator() (const double x) const
	Function value. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Public Attributes
JResult_t	y [NUMBER_OF_POINTS]
	function and derivative values More...

Static Public Attributes
static const int	NUMBER_OF_POINTS = N + 1

Detailed Description

template<unsigned int N, class JResult_t>
struct JTOOLS::JResultPolynome< N, JResult_t >

Data structure for result including value and N derivatives of function.

This data structure contains the following data mambers:

   JResultPolynome::y[0] = function value;
   JResultPolynome::y[i] = ith derivative; 
   JResultPolynome::y[N] = Nth derivative; 

This class implements the JMATH::JMath interface.

Definition at line 533 of file JResult.hh.

Member Typedef Documentation

template<unsigned int N, class JResult_t>

typedef JLANG::JClass<JResult_t>::argument_type JTOOLS::JResultPolynome< N, JResult_t >::argument_type

Definition at line 537 of file JResult.hh.

Constructor & Destructor Documentation

template<unsigned int N, class JResult_t>

JTOOLS::JResultPolynome< N, JResult_t >::JResultPolynome ( )

inline

Default constructor.

Definition at line 545 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] = JMATH::zero;
      }
    }

Member Function Documentation

template<unsigned int N, class JResult_t>

JTOOLS::JResultPolynome< N, JResult_t >::operator JResultDerivative< JResult_t > ( ) const

inline

Type conversion operator.

Returns

result

Definition at line 558 of file JResult.hh.

    {
      STATIC_CHECK(NUMBER_OF_POINTS >= 2);
      return JResultDerivative<JResult_t>(y[0], y[1]);
    }

template<unsigned int N, class JResult_t>

JTOOLS::JResultPolynome< N, JResult_t >::operator JResultHesse< JResult_t > ( ) const

inline

Type conversion operator.

Returns

result

Definition at line 570 of file JResult.hh.

    {
      STATIC_CHECK(NUMBER_OF_POINTS >= 3);
      return JResultHesse<JResult_t>(y[0], y[1], y[2]);
    }

template<unsigned int N, class JResult_t>

JResultPolynome& JTOOLS::JResultPolynome< N, JResult_t >::negate ( )

inline

Prefix unary minus for function value of PDF.

Returns

function value of PDF

Definition at line 582 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] = -y[i];
      }

      return *this;
    }

template<unsigned int N, class JResult_t>

JResultPolynome& JTOOLS::JResultPolynome< N, JResult_t >::add ( const JResultPolynome< N, JResult_t > &  value )

inline

Addition operator for function value of PDF.

Parameters

value

function value of PDF

Returns

function value of PDF

Definition at line 598 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] += value.y[i];
      }

      return *this;
    }

template<unsigned int N, class JResult_t>

JResultPolynome& JTOOLS::JResultPolynome< N, JResult_t >::sub ( const JResultPolynome< N, JResult_t > &  value )

inline

Subtraction operator for function value of PDF.

Parameters

value

function value of PDF

Returns

function value of PDF

Definition at line 614 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] -= value.y[i];
      }

      return *this;
    }

template<unsigned int N, class JResult_t>

JResultPolynome& JTOOLS::JResultPolynome< N, JResult_t >::mul ( const double  value )

inline

Multiplication operator for function value of PDF.

Parameters

value

multiplication factor

Returns

function value of PDF

Definition at line 630 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] *= value;
      }

      return *this;
    }

template<unsigned int N, class JResult_t>

JResultPolynome& JTOOLS::JResultPolynome< N, JResult_t >::div ( const double  value )

inline

Division operator for function value of PDF.

Parameters

value

multiplication factor

Returns

function value of PDF

Definition at line 646 of file JResult.hh.

    {
      for (int i = 0; i != NUMBER_OF_POINTS; ++i) {
        y[i] /= value;
      }

      return *this;
    }

template<unsigned int N, class JResult_t>

double JTOOLS::JResultPolynome< N, JResult_t >::getValue ( const double  x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 662 of file JResult.hh.

    {
      double w = 0.0;
      double z = 1.0;

      for (int i = 0; i != NUMBER_OF_POINTS; ++i, z *= x / i) {
        w += y[i] * z;
      }

      return w;
    }

template<unsigned int N, class JResult_t>

double JTOOLS::JResultPolynome< N, JResult_t >::operator() ( const double  x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 681 of file JResult.hh.

    {
      return getValue(x);
    }

template<class JFirst_t, class JSecond_t = JNullType>

JFirst_t& JMATH::JMath< JFirst_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

template<unsigned int N, class JResult_t>

const int JTOOLS::JResultPolynome< N, JResult_t >::NUMBER_OF_POINTS = N + 1

static

Definition at line 539 of file JResult.hh.

template<unsigned int N, class JResult_t>

JResult_t JTOOLS::JResultPolynome< N, JResult_t >::y[NUMBER_OF_POINTS]

function and derivative values

Definition at line 687 of file JResult.hh.

---

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

• JResult.hh