JMATH::JPower Class Reference

Power law function object. More...

#include <JPower.hh>

Public Member Functions
	JPower (const double alpha, const double factor=1.0)
	Constructor.
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.

Protected Attributes
double	alpha
double	factor

Friends
std::istream &	operator>> (std::istream &in, JPower &object)
	Read power from input.
std::ostream &	operator<< (std::ostream &out, const JPower &object)
	Write power to output.

Detailed Description

Power law function object.

Evaluation of function, derivative and integral values.

Definition at line 23 of file JPower.hh.

Constructor & Destructor Documentation

JPower()

JMATH::JPower::JPower ( const double alpha, const double factor = 1.0 )

inline

Constructor.

Parameters

alpha	spectral index
factor	multiplication factor

Definition at line 31 of file JPower.hh.

    {
      this->alpha  = alpha;
      this->factor = factor;
    }

Member Function Documentation

getValue()

double JMATH::JPower::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 45 of file JPower.hh.

    {
      return factor * pow(x, alpha);
    }

getDerivative()

double JMATH::JPower::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 57 of file JPower.hh.

    {
      return factor * alpha * pow(x, alpha - 1);
    }

getIntegral()

double JMATH::JPower::getIntegral ( const double x ) const

inline

Integral value.

Parameters

x	abscissa value

Returns

integral value

Definition at line 69 of file JPower.hh.

    {
      if (alpha != -1.0)
        return factor * pow(x, alpha + 1) / (alpha + 1);
      else
        return factor * log(x);
    }

operator()()

double JMATH::JPower::operator() ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 84 of file JPower.hh.

    {
      return getValue(x);
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JPower & object )

friend

Read power from input.

Parameters

in	input stream
object	power

Returns

input stream

Definition at line 97 of file JPower.hh.

    {
      in >> object.alpha >> object.factor;
      
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JPower & object )

friend

Write power to output.

Parameters

out	output stream
object	trigonometric

Returns

output stream

Definition at line 112 of file JPower.hh.

    {
      return out << object.alpha << ' ' << object.factor;
    }

Member Data Documentation

alpha

double JMATH::JPower::alpha

protected

Definition at line 118 of file JPower.hh.

factor

double JMATH::JPower::factor

protected

Definition at line 119 of file JPower.hh.

---

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

• JPower.hh