JFIT::JEnergy Class Reference

Data structure for fit of energy. More...

#include <JEnergy.hh>

Inheritance diagram for JFIT::JEnergy:

Public Types
typedef double JEnergy::*	parameter_type

Public Member Functions
	JEnergy ()
	Default constructor. More...
	JEnergy (const double X)
	Constructor. More...
const JEnergy &	getEnergy () const
	Get Energy. More...
void	setEnergy (const JEnergy &energy)
	Set Energy. More...
bool	less (const JEnergy &X) const
	Less than method. More...
JEnergy &	negate ()
	Prefix unary minus. More...
JEnergy &	add (const JEnergy &value)
	Addition operator. More...
JEnergy &	sub (const JEnergy &value)
	Subtraction operator. More...
JEnergy &	mul (const double value)
	Multiplication operator. More...
JEnergy &	div (const double value)
	Division operator. More...
double	getX () const
	Get energy. More...
double	getE () const
	Get energy. More...
void	putE (const double E)
	Put energy. More...
double	getDE () const
	Get derivative of energy. More...
JEnergy &	mul (const JNullType &object)
	Multiply with object. More...

Static Public Member Functions
static JEnergy	min ()
	Get minimum possible value. More...
static JEnergy	max ()
	Get maximum possible value. More...
static parameter_type	pE ()

Protected Attributes
double	__X

Friends
double	fabs (const JEnergy &energy)
	Get absolute value. More...
std::istream &	operator>> (std::istream &in, JEnergy &object)
	Read object from input. More...
std::ostream &	operator<< (std::ostream &out, const JEnergy &object)
	Write object to output. More...

Detailed Description

Data structure for fit of energy.

The internal value is equal to the logarithm of the energy.

Definition at line 24 of file JEnergy.hh.

Member Typedef Documentation

typedef double JEnergy::* JFIT::JEnergy::parameter_type

Definition at line 257 of file JEnergy.hh.

Constructor & Destructor Documentation

JFIT::JEnergy::JEnergy ( )

inline

Default constructor.

Definition at line 32 of file JEnergy.hh.

              :
      __X(0.0)
    {}

JFIT::JEnergy::JEnergy ( const double  X )

inline

Constructor.

Parameters

X	x-value [log(E/GeV)]

Definition at line 42 of file JEnergy.hh.

                            :
      __X(X)
    {}

Member Function Documentation

const JEnergy& JFIT::JEnergy::getEnergy ( ) const

inline

Get Energy.

Returns

Energy

Definition at line 52 of file JEnergy.hh.

    {
      return static_cast<const JEnergy&>(*this);
    }

void JFIT::JEnergy::setEnergy ( const JEnergy &  energy )

inline

Set Energy.

Parameters

energy

Energy

Definition at line 63 of file JEnergy.hh.

    {
      static_cast<JEnergy&>(*this) = energy;
    }

bool JFIT::JEnergy::less ( const JEnergy &  X ) const

inline

Less than method.

Parameters

X	Energy [log(E/GeV)]

Returns

true if this energy less than given energy; else false

Definition at line 75 of file JEnergy.hh.

    {
      return __X < X.__X;
    }

JEnergy& JFIT::JEnergy::negate ( )

inline

Prefix unary minus.

Returns

Energy

Definition at line 86 of file JEnergy.hh.

    {
      __X = -__X;

      return *this;
    }

JEnergy& JFIT::JEnergy::add ( const JEnergy &  value )

inline

Addition operator.

Parameters

value

Energy

Returns

Energy

Definition at line 100 of file JEnergy.hh.

    {
      __X += value.__X;

      return *this;
    }

JEnergy& JFIT::JEnergy::sub ( const JEnergy &  value )

inline

Subtraction operator.

Parameters

value

Energy

Returns

Energy

Definition at line 114 of file JEnergy.hh.

    {
      __X -= value.__X;

      return *this;
    }

JEnergy& JFIT::JEnergy::mul ( const double  value )

inline

Multiplication operator.

Parameters

value

multiplication factor

Returns

Energy

Definition at line 128 of file JEnergy.hh.

    {
      __X *= value;

      return *this;
    }

JEnergy& JFIT::JEnergy::div ( const double  value )

inline

Division operator.

Parameters

value

multiplication factor

Returns

Energy

Definition at line 142 of file JEnergy.hh.

    {
      __X /= value;

      return *this;
    }

double JFIT::JEnergy::getX ( ) const

inline

Get energy.

Returns

Energy [log(E/GeV)]

Definition at line 155 of file JEnergy.hh.

    {
      return __X;
    }

double JFIT::JEnergy::getE ( ) const

inline

Get energy.

Returns

Energy [GeV]

Definition at line 166 of file JEnergy.hh.

    {
      return pow(10.0, __X);
    }

void JFIT::JEnergy::putE ( const double  E )

inline

Put energy.

Parameters

E	Energy [GeV]

Definition at line 177 of file JEnergy.hh.

    {
      __X = log10(E);
    }

double JFIT::JEnergy::getDE ( ) const

inline

Get derivative of energy.

Returns

dE/dx [GeV]

Definition at line 188 of file JEnergy.hh.

    {
      return getE() * log(10.0);
    }

static JEnergy JFIT::JEnergy::min ( )

inlinestatic

Get minimum possible value.

Returns

minimum possible value

Definition at line 210 of file JEnergy.hh.

    {
      return JEnergy(-std::numeric_limits<double>::max());
    }

static JEnergy JFIT::JEnergy::max ( )

inlinestatic

Get maximum possible value.

Returns

maximum possible value

Definition at line 221 of file JEnergy.hh.

    {
      return JEnergy(+std::numeric_limits<double>::max());
    }

static parameter_type JFIT::JEnergy::pE ( )

inlinestatic

Definition at line 259 of file JEnergy.hh.

{ return &JEnergy::__X; }

JEnergy & JMATH::JMath< JEnergy , JNullType >::mul ( const JNullType &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Function Documentation

double fabs ( const JEnergy &  energy )

friend

Get absolute value.

Parameters

energy

energy

Definition at line 199 of file JEnergy.hh.

    {
      return std::fabs(energy.__X);
    }

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

friend

Read object from input.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 234 of file JEnergy.hh.

    {
      in >> object.__X;

      return in;
    }

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

friend

Write object to output.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 249 of file JEnergy.hh.

    {
      out << object.__X;

      return out;
    }

Member Data Documentation

double JFIT::JEnergy::__X

protected

Definition at line 262 of file JEnergy.hh.

---

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

• JEnergy.hh