FunctionWrap Class Reference

#include <FunctionWrap.h>

Inheritance diagram for FunctionWrap:

Inheritance graph
FunctionBasewrapper\< FunctionBase \>
[legend]
Collaboration diagram for FunctionWrap:

Collaboration graph
FunctionBasewrapper\< FunctionBase \>
[legend]
List of all members.

Detailed Description

A wrapper class for FunctionBase.

This class allows one to implement in Python a derived class of FunctionBase.

Note:
This class needs Python 2.3 or later to be fully functional.
Author:
Paul F. Kunz <Paul_Kunz@slac.stanford.edu>
with a lot of help from David Abrahams <dave@boost-consulting.com>

Definition at line 30 of file FunctionWrap.h.

Public Member Functions

virtual void addToComposite (FunctionBase *)
 Does nothing.
FunctionBaseclone () const
 Make copy of object, including copy of Python object.
virtual int count ()
 Returns 0.
double derivByParm (int, double) const
 
Note:
This member function is only available with Python 2.3 or later.

unsigned int dimensions () const
 Returns the number of dimensions of the data coordinate.
 FunctionWrap ()
 The default constructor.
 FunctionWrap (const FunctionWrap &)
 The copy constructor.
 FunctionWrap (const FunctionBase &base)
 Constructor.
virtual const std::vector<
double > & 
getParameters () const
 Returns the values of the parameters as a vector.
virtual bool hasDerivatives () const
 Returns true if the Python function has implemented returning partial derivatives.
void initialize ()
 
Note:
This function is only available for Python 2.3 or later.

void initialParameters (const FunctionHelper *)
 Sets the FunctionHelper so that the function can calculate a reasonable set of initial parameter values.
virtual double integrate (double lower_limit, double upper_limit) const
virtual bool isComposite () const
 Returns false.
const std::string & name () const
 Returns the name of the function.
double operator() (const std::vector< double > &) const
 
Note:
This function is only available for Python 2.3 or later.

double operator() (double) const
 
Note:
This function is only available for Python 2.3 or later.

virtual const std::vector<
std::string > & 
parmNames () const
 Returns a reference to a vector of parameter names.
virtual void removeFromComposite (FunctionBase *)
 Does nothing.
void setName (const std::string &name)
 Sets the name of the function.
virtual std::vector< double
>::const_iterator 
setParameters (std::vector< double >::const_iterator it)
 Sets the parameter values to the value pointed to by the iterator.
virtual void setParameters (const std::vector< double > &incr)
 Sets the parameter values.
void setParmNames (const std::vector< std::string > &names)
 Sets the names of the parameters and re-sizes the number of parameters available.
virtual int size () const
 Returns the number of parameters.
virtual ~FunctionWrap ()
 The destructor.

Protected Member Functions

virtual void resize ()
 Re-sizes the appropriate vectors maintained in this base class.
void setName (const char *)
 Sets the name of the function.

Protected Attributes

std::string m_name
 The name of the function.
std::vector< std::string > m_parm_names
 The names of the function parameters.
std::vector< double > m_parms
 The parameter values.

Private Member Functions

template<class T>
boost::python::object get_owner (T *me) const
 Find the Python object that owns this object.

Private Attributes

boost::python::object invert_ownership
 The new ownership.


Constructor & Destructor Documentation

FunctionWrap ( const FunctionBase base  ) 

Constructor.

Definition at line 110 of file FunctionWrap.cxx.

FunctionWrap ( const FunctionWrap  ) 

The copy constructor.

Definition at line 116 of file FunctionWrap.cxx.

FunctionWrap (  ) 

The default constructor.

Definition at line 104 of file FunctionWrap.cxx.

~FunctionWrap (  )  [virtual]

The destructor.

Definition at line 122 of file FunctionWrap.cxx.

References FunctionWrap::get_owner().


Member Function Documentation

void addToComposite ( FunctionBase  )  [virtual, inherited]

Does nothing.

Derived classes that are a composite of functions should override this member function and add functions to the composite.

Reimplemented in LinearSumFunction.

Definition at line 166 of file FunctionBase.cxx.

FunctionBase * clone (  )  const [virtual]

Make copy of object, including copy of Python object.

Note:
One can't call clone() if implemented in the Python class, because if it constructs a new object, it will also destroy it thus leaving a dangling reference for C++. The attempting to do that is commented out in the implementation. Since all the C++ FunctionBase prototypes in the FunctionFactory are created with their default constructor, this implementation just calls the default constructor of the Python class. The net effect should be the same as a call to clone(). See http://mail.python.org/pipermail/c++-sig/2005-July/009262.html

Reimplemented from FunctionBase.

Definition at line 183 of file FunctionWrap.cxx.

References FunctionWrap::get_owner(), and FunctionWrap::invert_ownership.

int count (  )  [virtual, inherited]

Returns 0.

Derived classes that are a composite of functions should override this member function to return the number of functions in the composite.

Reimplemented in LinearSumFunction.

Definition at line 174 of file FunctionBase.cxx.

double derivByParm ( int  i,
double  x 
) const [virtual]

Note:
This member function is only available with Python 2.3 or later.

Bug:
Should attempt to call derivByParm to implement hasDerivatives()

Reimplemented from FunctionBase.

Definition at line 255 of file FunctionWrap.cxx.

References FunctionWrap::get_owner().

unsigned int dimensions (  )  const [virtual]

Returns the number of dimensions of the data coordinate.

This implementation in the base class returns 1. Derived class should override this function if the data coordinate is multi-dimensional.

Reimplemented from FunctionBase.

Definition at line 148 of file FunctionWrap.cxx.

References FunctionBase::dimensions(), and FunctionWrap::get_owner().

object get_owner ( T *  me  )  const [inline, private]

Find the Python object that owns this object.

Definition at line 137 of file FunctionWrap.cxx.

Referenced by FunctionWrap::clone(), FunctionWrap::derivByParm(), FunctionWrap::dimensions(), FunctionWrap::initialize(), FunctionWrap::operator()(), and FunctionWrap::~FunctionWrap().

const vector< double > & getParameters (  )  const [virtual, inherited]

Returns the values of the parameters as a vector.

The function is non-const because a derived class may need to create the vector.

Reimplemented in LinearSumFunction.

Definition at line 99 of file FunctionBase.cxx.

References FunctionBase::m_parms.

Referenced by FunctionProjectorXML::createElement(), FuncParmRep::drawProjectedValues(), hippodraw::Python::export_FunctionBase(), FunctionRep::parameters(), FunctionProjector::saveParameters(), and FunctionProjector::setParameters().

bool hasDerivatives (  )  const [virtual]

Returns true if the Python function has implemented returning partial derivatives.

Reimplemented from FunctionBase.

Definition at line 170 of file FunctionWrap.cxx.

void initialize (  )  [virtual]

Note:
This function is only available for Python 2.3 or later.

Reimplemented from FunctionBase.

Definition at line 283 of file FunctionWrap.cxx.

References FunctionWrap::get_owner(), and FunctionBase::resize().

Referenced by hippodraw::Python::export_FunctionBase().

void initialParameters ( const FunctionHelper helper  )  [virtual]

Sets the FunctionHelper so that the function can calculate a reasonable set of initial parameter values.

Reimplemented from FunctionBase.

Definition at line 359 of file FunctionWrap.cxx.

double integrate ( double  lower_limit,
double  upper_limit 
) const [virtual, inherited]

As of now all the integration is done here numerically using the trapezoidal rule. Derived class may implement an analytical expression in place of this numerical method.

Definition at line 138 of file FunctionBase.cxx.

References FunctionBase::operator()().

bool isComposite (  )  const [virtual, inherited]

Returns false.

Derived classes that are a composite of functions should override this member function and return true.

Reimplemented in LinearSumFunction.

Definition at line 161 of file FunctionBase.cxx.

Referenced by FunctionRep::isComposite(), FunctionController::restoreParameters(), and FunctionController::saveParameters().

const string & name (  )  const [inherited]

Returns the name of the function.

Definition at line 81 of file FunctionBase.cxx.

References FunctionBase::m_name.

Referenced by FunctionProjectorXML::createElement(), FunctionController::createNTuple(), hippodraw::Python::export_FunctionBase(), FunctionController::functionNames(), FunctionProjector::getTitle(), FunctionProjector::getYLabel(), and LinearSumFunction::parmNames().

double operator() ( const std::vector< double > &   )  const [virtual]

Note:
This function is only available for Python 2.3 or later.

Reimplemented from FunctionBase.

Definition at line 329 of file FunctionWrap.cxx.

References FunctionWrap::get_owner(), and FunctionBase::size().

double operator() ( double  x  )  const [virtual]

Note:
This function is only available for Python 2.3 or later.

Requests:
Why is exception being thrown for logParabolic.py and are we handling the fix correctly

Reimplemented from FunctionBase.

Definition at line 303 of file FunctionWrap.cxx.

References FunctionWrap::get_owner().

const vector< string > & parmNames (  )  const [virtual, inherited]

Returns a reference to a vector of parameter names.

Reimplemented in LinearSumFunction.

Definition at line 86 of file FunctionBase.cxx.

References FunctionBase::m_parm_names.

Referenced by FuncParmRep::drawProjectedValues(), hippodraw::Python::export_FunctionBase(), and FunctionRep::parmNames().

void removeFromComposite ( FunctionBase  )  [virtual, inherited]

Does nothing.

Derived classes that are a composite of functions should override this member function and remove functions from the composite.

Reimplemented in LinearSumFunction.

Definition at line 170 of file FunctionBase.cxx.

void resize (  )  [protected, virtual, inherited]

Re-sizes the appropriate vectors maintained in this base class.

Derived classes should call this member function after initializing the m_parm_names data member, as the new size is taken from that data member's size.

Definition at line 71 of file FunctionBase.cxx.

References FunctionBase::m_parm_names, FunctionBase::m_parms, and FunctionBase::size().

Referenced by Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), FunctionWrap::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), FunctionWrap::setParmNames(), and FunctionBase::setParmNames().

void setName ( const char *   )  [protected, inherited]

Sets the name of the function.

Definition at line 66 of file FunctionBase.cxx.

References FunctionBase::m_name.

Referenced by FunctionWrap::setName().

void setName ( const std::string &  name  ) 

Sets the name of the function.

Definition at line 236 of file FunctionWrap.cxx.

References FunctionBase::setName().

Referenced by hippodraw::Python::export_FunctionBase().

vector< double >::const_iterator setParameters ( std::vector< double >::const_iterator  it  )  [virtual, inherited]

Sets the parameter values to the value pointed to by the iterator.

Returns an iterator to a data element one past the last used data element.

Reimplemented in LinearSumFunction.

Definition at line 114 of file FunctionBase.cxx.

References FunctionBase::m_parms, and FunctionBase::size().

void setParameters ( const std::vector< double > &  incr  )  [virtual, inherited]

Sets the parameter values.

Derived classes should implement this function by invoking incrementValues ( vector< double >::const_iterator ) so that they correctly work with the LinearSumFunction class.

Definition at line 106 of file FunctionBase.cxx.

Referenced by hippodraw::Python::export_FunctionBase(), FunctionProjector::restoreParameters(), FunctionProjectorXML::setAttributes(), and FunctionProjector::setParameters().

void setParmNames ( const std::vector< std::string > &  names  ) 

Sets the names of the parameters and re-sizes the number of parameters available.

Reimplemented from FunctionBase.

Definition at line 243 of file FunctionWrap.cxx.

References FunctionBase::m_parm_names, and FunctionBase::resize().

Referenced by hippodraw::Python::export_FunctionBase().

int size (  )  const [virtual, inherited]

Returns the number of parameters.

Reimplemented in LinearSumFunction.

Definition at line 156 of file FunctionBase.cxx.

References FunctionBase::m_parm_names.

Referenced by Novosibirsk::initialParameters(), LogParabola::initialParameters(), Gaussian::initialParameters(), FunctionWrap::operator()(), FunctionBase::resize(), FunctionProjectorXML::setAttributes(), and FunctionBase::setParameters().


Member Data Documentation

boost::python::object invert_ownership [private]

The new ownership.

Definition at line 37 of file FunctionWrap.h.

Referenced by FunctionWrap::clone().

std::string m_name [protected, inherited]

The name of the function.

Definition at line 103 of file FunctionBase.h.

Referenced by FunctionBase::FunctionBase(), Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), LinearSumFunction::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), FunctionBase::name(), and FunctionBase::setName().

std::vector<std::string> m_parm_names [protected, inherited]

The names of the function parameters.

Definition at line 106 of file FunctionBase.h.

Referenced by Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), LinearSumFunction::parmNames(), FunctionBase::parmNames(), FunctionBase::resize(), FunctionWrap::setParmNames(), FunctionBase::setParmNames(), and FunctionBase::size().

std::vector< double > m_parms [protected, inherited]

The parameter values.

Definition at line 109 of file FunctionBase.h.

Referenced by BrokenPowerLaw::BrokenPowerLaw(), Erfc::calcRed(), Chi2Dist::Chi2Dist(), ConstantF::ConstantF(), Gaussian::derivByMean(), Landau::derivByNorm(), Gaussian::derivByNorm(), Quadratic2::derivByParm(), PowerLaw::derivByParm(), LogParabola::derivByParm(), Exponential::derivByParm(), Erfc::derivByParm(), Chi2Dist::derivByParm(), BrokenPowerLaw::derivByParm(), Landau::derivByPeak(), Landau::derivBySigma(), Gaussian::derivBySigma(), Erfc::Erfc(), Exponential::Exponential(), Gaussian::Gaussian(), LinearSumFunction::getParameters(), FunctionBase::getParameters(), Quadratic2::initialParameters(), Quadratic::initialParameters(), PowerLaw::initialParameters(), Novosibirsk::initialParameters(), LogParabola::initialParameters(), LogNormal::initialParameters(), Linear::initialParameters(), Landau::initialParameters(), Gaussian::initialParameters(), Exponential::initialParameters(), Erfc::initialParameters(), ConstantF::initialParameters(), Chi2Dist::initialParameters(), BrokenPowerLaw::initialParameters(), Landau::Landau(), Linear::Linear(), LogNormal::LogNormal(), LogParabola::LogParabola(), Novosibirsk::Novosibirsk(), Quadratic2::operator()(), Quadratic::operator()(), PowerLaw::operator()(), Novosibirsk::operator()(), LogParabola::operator()(), LogNormal::operator()(), Linear::operator()(), Landau::operator()(), Gaussian::operator()(), Exponential::operator()(), ConstantF::operator()(), Chi2Dist::operator()(), BrokenPowerLaw::operator()(), PowerLaw::PowerLaw(), Quadratic::Quadratic(), Quadratic2::Quadratic2(), FunctionBase::resize(), and FunctionBase::setParameters().


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen