JMATH::JLog< JF1_t > Struct Template Reference

Logarithm of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JLog< JF1_t >:

Public Member Functions
	JLog ()
	Default constructor. More...
	JLog (const JF1_t &f1)
	Constructor. More...
double	getValue (const double x) const
	Function value. More...
double	getDerivative (const double x) const
	Derivative value. More...
const JLog &	getGradient (const double x) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...

Detailed Description

template<class JF1_t>
struct JMATH::JLog< JF1_t >

Logarithm of function.

Definition at line 2555 of file JMathlib.hh.

Constructor & Destructor Documentation

template<class JF1_t >

JMATH::JLog< JF1_t >::JLog ( )

inline

Default constructor.

Definition at line 2565 of file JMathlib.hh.

           :
      JF1_t()
    {}

template<class JF1_t >

JMATH::JLog< JF1_t >::JLog ( const JF1_t &  f1 )

inline

Constructor.

Parameters

f1

function

Definition at line 2575 of file JMathlib.hh.

                          :
      JF1_t(f1)
    {}

Member Function Documentation

template<class JF1_t >

double JMATH::JLog< JF1_t >::getValue ( const double  x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2586 of file JMathlib.hh.

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

template<class JF1_t >

double JMATH::JLog< JF1_t >::getDerivative ( const double  x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2598 of file JMathlib.hh.

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

template<class JF1_t >

const JLog& JMATH::JLog< JF1_t >::getGradient ( const double  x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2610 of file JMathlib.hh.

    {
      static JLog gradient;

      gradient  =  static_cast<const JF1_t&>(*this).getGradient(x);
      gradient /= (static_cast<const JF1_t&>(*this).getValue(x));

      return gradient;
    }

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

---

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

• JMathlib.hh