A wrapper class for FunctionBase. More...

#include <FunctionWrap.h>

Inheritance diagram for FunctionWrap:

Collaboration diagram for FunctionWrap:

Public Member Functions
virtual void	addToComposite (FunctionBase *)
	Does nothing. More...

FunctionBase *	clone () const
	Make copy of object, including copy of Python object. More...

virtual int	count ()
	Returns 0. More...

double	derivByParm (int, double) const

unsigned int	dimensions () const
	Returns the number of dimensions of the data coordinate. More...

	FunctionWrap (const FunctionBase &base)
	Constructor. More...

	FunctionWrap (const FunctionWrap &)
	The copy constructor. More...

	FunctionWrap ()
	The default constructor. More...

template<class T >
object	get_owner (T *) const

virtual const std::vector< int > &	getFixedFlags () const
	Returns the flags indicating which parameters should remain fixed during any minimization process. More...

virtual const std::vector < double > &	getParameters () const
	Returns the values of the parameters as a vector. More...

virtual bool	hasDerivatives () const
	Returns `true` if the Python function has implemented returning partial derivatives. More...

void	initialize ()

void	initialParameters (const FunctionHelper *)
	Sets the FunctionHelper so that the function can calculate a reasonable set of initial parameter values. More...

virtual double	integrate (double lower_limit, double upper_limit) const
	Returns the integral of the function from the lower limit to the higher limit. More...

virtual bool	isComposite () const
	Returns `false`. More...

const std::string &	name () const
	Returns the name of the function. More...

double	operator() (double) const

double	operator() (const std::vector< double > &) const

virtual const std::vector < std::string > &	parmNames () const
	Returns a reference to a vector of parameter names. More...

virtual void	removeFromComposite (FunctionBase *)
	Does nothing. More...

virtual void	setFixedFlags (const std::vector< int > &flags)
	Sets to flags indicating that a function parameter is to be held fixed in a minimization process. More...

virtual std::vector< int > ::const_iterator	setFixedFlags (std::vector< int >::const_iterator it)

void	setName (const std::string &name)
	Sets the name of the function. More...

virtual void	setParameters (const std::vector< double > &incr)
	Sets the parameter values. More...

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. More...

void	setParmNames (const std::vector< std::string > &names)
	Sets the names of the parameters and re-sizes the number of parameters available. More...

virtual int	size () const
	Returns the number of parameters. More...

virtual	~FunctionWrap ()
	The destructor. More...

Protected Member Functions
virtual void	resize ()
	Re-sizes the appropriate vectors maintained in this base class. More...

void	setName (const char *)
	Sets the name of the function. More...

Protected Attributes
std::vector< int >	m_fixed_flags
	The flags to indicated which parameters are to be held fixed during minimization of this objective function. More...

std::string	m_name
	The name of the function. More...

std::vector< std::string >	m_parm_names
	The names of the function parameters. More...

std::vector< double >	m_parms
	The parameter values. More...

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

Private Attributes
boost::python::object	invert_ownership
	The new ownership. More...

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_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu

with a lot of help from David Abrahams dave@.nosp@m.boos.nosp@m.t-con.nosp@m.sult.nosp@m.ing.c.nosp@m.om

Definition at line 30 of file FunctionWrap.h.

Constructor & Destructor Documentation

FunctionWrap ( const FunctionBase & base )

Constructor.

Definition at line 110 of file FunctionWrap.cxx.

FunctionWrap ( const FunctionWrap & wrap )

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 * )

virtualinherited

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 193 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 ( )

virtualinherited

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 201 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(), and i.

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().

boost::python::object get_owner ( T * me ) const

private

Find the Python object that owns this object.

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

object get_owner ( T * ) const

Definition at line 137 of file FunctionWrap.cxx.

const vector< int > & getFixedFlags ( ) const

virtualinherited

Returns the flags indicating which parameters should remain fixed during any minimization process.

Reimplemented in LinearSumFunction.

Definition at line 106 of file FunctionBase.cxx.

References FunctionBase::m_fixed_flags.

const vector< double > & getParameters ( ) const

virtualinherited

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 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.

References yes.

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().

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	a,
		double	b
	)		const

virtualinherited

Returns the integral of the function from the lower limit to the higher limit.

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.

Requests:: Override this method in derived classes when calculation of integral can be done analyically.

Requests:: Check if this is the best algorithm. Its looks different from the one found in http://osl.iu.edu/%7Etveldhui/papers/techniques/

Definition at line 165 of file FunctionBase.cxx.

References i, and FunctionBase::operator()().

bool isComposite ( ) const

virtualinherited

Returns false.

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

Reimplemented in LinearSumFunction.

Definition at line 188 of file FunctionBase.cxx.

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 FunctionController::functionNames(), FunctionProjector::getTitle(), FunctionProjector::getYLabel(), LinearSumFunction::parmNames(), and FunctionBase::setName().

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().

double operator() ( const std::vector< double > & x ) 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().

const vector< string > & parmNames ( ) const

virtualinherited

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.

void removeFromComposite ( FunctionBase * )

virtualinherited

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 197 of file FunctionBase.cxx.

void resize ( )

protectedvirtualinherited

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 72 of file FunctionBase.cxx.

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

Referenced by LogNormal::initialize(), Novosibirsk::initialize(), FunctionWrap::initialize(), FunctionWrap::setParmNames(), and FunctionBase::setParmNames().

void setFixedFlags ( const std::vector< int > & flags )

virtualinherited

Sets to flags indicating that a function parameter is to be held fixed in a minimization process.

Definition at line 113 of file FunctionBase.cxx.

References it.

vector< int >::const_iterator setFixedFlags ( std::vector< int >::const_iterator it )

virtualinherited

Definition at line 141 of file FunctionBase.cxx.

References i, it, FunctionBase::m_fixed_flags, FunctionBase::m_parms, and FunctionBase::size().

void setName ( const std::string & name )

Sets the name of the function.

Note: We have this function here so that FunctionBase::setName can remain protected and yet the Boost.Python and SIP interfaces can call this public member function.

Definition at line 236 of file FunctionWrap.cxx.

References FunctionBase::setName().

void setName ( const char * name )

protectedinherited

Sets the name of the function.

Definition at line 67 of file FunctionBase.cxx.

References FunctionBase::m_name, and FunctionBase::name().

Referenced by FunctionWrap::setName().

void setParameters ( const std::vector< double > & incr )

virtualinherited

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 121 of file FunctionBase.cxx.

References it.

Referenced by FunctionProjector::restoreParameters(), and FunctionProjector::setParameters().

vector< double >::const_iterator setParameters ( std::vector< double >::const_iterator it )

virtualinherited

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 129 of file FunctionBase.cxx.

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

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

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