Genfun::Variable Class Reference

#include <Variable.hh>

Inheritance diagram for Genfun::Variable:

Public Member Functions
	Variable (unsigned int selectionIndex=0, unsigned int dimensionality=1)
	Variable (const Variable &right)
virtual	~Variable ()
virtual double	operator() (double argument) const override
virtual double	operator() (const Argument &a) const override
virtual unsigned int	dimensionality () const override
unsigned int	index () const
Derivative	partial (unsigned int) const override
virtual bool	hasAnalyticDerivative () const override
Public Member Functions inherited from Genfun::AbsFunction
	AbsFunction ()
	AbsFunction (const AbsFunction &right)
virtual	~AbsFunction ()
virtual unsigned int	dimensionality () const
virtual double	operator() (double argument) const =0
virtual double	operator() (const Argument &argument) const =0
virtual AbsFunction *	clone () const =0
virtual FunctionComposition	operator() (const AbsFunction &f) const
virtual ParameterComposition	operator() (const AbsParameter &p) const
Derivative	derivative (const Variable &v) const
Derivative	prime () const
virtual bool	hasAnalyticDerivative () const
virtual Derivative	partial (unsigned int) const

Detailed Description

Author

Definition at line 19 of file Variable.hh.

Constructor & Destructor Documentation

Variable() [1/2]

Genfun::Variable::Variable	(	unsigned int	selectionIndex = 0,
		unsigned int	dimensionality = 1
	)

Definition at line 9 of file Variable.cc.

                                                                   :
  _selectionIndex(selectionIndex),
  _dimensionality(dmsnlty)
{}

Variable() [2/2]

Genfun::Variable::Variable

(

const Variable &

right

)

Definition at line 14 of file Variable.cc.

                                        :
  AbsFunction(right),
  _selectionIndex(right._selectionIndex),
  _dimensionality(right._dimensionality)
{
}

~Variable()

Genfun::Variable::~Variable ( )

virtual

Definition at line 21 of file Variable.cc.

                    {
}

Member Function Documentation

dimensionality()

unsigned int Genfun::Variable::dimensionality ( ) const

overridevirtual

Reimplemented from Genfun::AbsFunction.

Definition at line 53 of file Variable.cc.

                                            {
  return _dimensionality;
} 

hasAnalyticDerivative()

virtual bool Genfun::Variable::hasAnalyticDerivative ( ) const

inlineoverridevirtual

Reimplemented from Genfun::AbsFunction.

Definition at line 49 of file Variable.hh.

{return true;}

index()

unsigned int Genfun::Variable::index

(

)

const

Definition at line 34 of file Variable.cc.

                                   {
  return _selectionIndex;
}

Referenced by Genfun::AbsFunction::derivative(), Classical::RungeKuttaSolver::equationOf(), Classical::PhaseSpace::start(), and Classical::PhaseSpace::startValue().

operator()() [1/2]

double Genfun::Variable::operator() ( const Argument &  a ) const

overridevirtual

Implements Genfun::AbsFunction.

Definition at line 29 of file Variable.cc.

                                                      {
  if  (!(_selectionIndex<a.dimension())) throw std::runtime_error("Genfun::Varaible selection index out of bounds");
  return a[_selectionIndex];
}

operator()() [2/2]

double Genfun::Variable::operator() ( double  argument ) const

overridevirtual

Implements Genfun::AbsFunction.

Definition at line 24 of file Variable.cc.

                                           {
  if (_selectionIndex!=0) throw std::runtime_error("Genfun::Variable: selection index !=0") ;
  return x;
}

partial()

Derivative Genfun::Variable::partial ( unsigned int  mindex ) const

overridevirtual

Reimplemented from Genfun::AbsFunction.

Definition at line 39 of file Variable.cc.

                                                      {
  int kroneckerDelta = mindex==_selectionIndex ? 1 : 0;
 
  const AbsFunction * f= new FixedConstant(kroneckerDelta);
  for (unsigned int i=1;i<_dimensionality;i++) {
    const AbsFunction & g = (*f)%FixedConstant(kroneckerDelta);
    delete f;
    f=g.clone();
  }
  Derivative retVal(f);
  delete f;
  return retVal;
}

---

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

• Variable.hh
• Variable.cc