JMATH::JTrigonometric Class Reference

Trigonometric function object for sin and cos. More...

#include <JTrigonometric.hh>

Public Types
typedef double(*	pF) (double)
	Type definition of pointer to trigonometric function. More...

Public Member Functions
	JTrigonometric (pF f1, const double factor=1.0)
	Constructor. 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...
JTrigonometric	getDerivative () const
	Derivative function. More...
JTrigonometric	getIntegral () const
	Integral function. More...

Protected Attributes
pF	f1
double	factor

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

Detailed Description

Trigonometric function object for sin and cos.

Evaluation of function, derivative and integral values.

Definition at line 28 of file JTrigonometric.hh.

Member Typedef Documentation

pF

typedef double(* JMATH::JTrigonometric::pF) (double)

Type definition of pointer to trigonometric function.

Definition at line 33 of file JTrigonometric.hh.

Constructor & Destructor Documentation

JTrigonometric()

JMATH::JTrigonometric::JTrigonometric ( pF  f1, const double  factor = 1.0  )

inline

Constructor.

Parameters

f1	pointer to function
factor	multiplication factor

Definition at line 42 of file JTrigonometric.hh.

    {
      if (f1 != sin && f1 != cos) {
        THROW(JException, "Invalid trigonometric function.");
      }
      
      this->f1     = f1;
      this->factor = factor;
    }

Member Function Documentation

getValue()

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

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 59 of file JTrigonometric.hh.

    {
      return factor * f1(x);
    }

getDerivative() [1/2]

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

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 71 of file JTrigonometric.hh.

    {
      return getDerivative().getValue(x);
    }

getIntegral() [1/2]

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

inline

Integral value.

Parameters

x	abscissa value

Returns

integral value

Definition at line 83 of file JTrigonometric.hh.

    {
      return getIntegral().getValue(x);
    }

operator()()

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

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 95 of file JTrigonometric.hh.

    {
      return getValue(x);
    }

getDerivative() [2/2]

JTrigonometric JMATH::JTrigonometric::getDerivative ( ) const

inline

Derivative function.

Returns

derivative function

Definition at line 106 of file JTrigonometric.hh.

    {
      if      (f1 == sin)
        return JTrigonometric(cos, +factor);
      else if (f1 == cos)
        return JTrigonometric(sin, -factor);
      else
        THROW(JException, "Invalid trigonometric function.");
    }

getIntegral() [2/2]

JTrigonometric JMATH::JTrigonometric::getIntegral ( ) const

inline

Integral function.

Returns

integral function

Definition at line 122 of file JTrigonometric.hh.

    {
      if      (f1 == sin)
        return JTrigonometric(cos, -factor);
      else if (f1 == cos)
        return JTrigonometric(sin, +factor);
      else
        THROW(JException, "Invalid trigonometric function.");
    }

Friends And Related Function Documentation

operator>>

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

friend

Read trigonometric from input.

Parameters

in	input stream
object	trigonometric

Returns

input stream

Definition at line 140 of file JTrigonometric.hh.

    {
      std::string buffer;
 
      if (in >> object.factor >> buffer) {
        if      (buffer == "sin")
          object.f1 = sin;
        else if (buffer == "cos")
          object.f1 = cos;
        else
          THROW(JException, "Invalid trigonometric function.");
      }
      
      return in;
    }

operator<<

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

friend

Write trigonometric to output.

Parameters

out	output stream
object	trigonometric

Returns

output stream

Definition at line 164 of file JTrigonometric.hh.

    {
      out << object.factor;
 
      if      (object.f1 == sin)
        out << ' ' << "sin";
      else if (object.f1 == cos)
        out << ' ' << "cos";
      else
        THROW(JException, "Invalid trigonometric function.");
 
      return out;
    }

Member Data Documentation

f1

pF JMATH::JTrigonometric::f1

protected

Definition at line 179 of file JTrigonometric.hh.

factor

double JMATH::JTrigonometric::factor

protected

Definition at line 180 of file JTrigonometric.hh.

---

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

• JTrigonometric.hh