Abstract base class for parameters. More...

#include <parameter.h>

Inheritance diagram for nest::Parameter:

Public Member Functions
	Parameter ()
	Default constructor. More...

	Parameter (double_t cutoff)
	Constructor. More...

	Parameter (const DictionaryDatum &d)
	Constructor Parameter that can be set in the Dictionary: cutoff - Values less than the cutoff are set to zero. More...

virtual	~Parameter ()
	Virtual destructor. More...

double_t	value (const Position< 2 > &p, librandom::RngPtr &rng) const

double_t	value (const Position< 3 > &p, librandom::RngPtr &rng) const

virtual double_t	raw_value (const Position< 2 > &, librandom::RngPtr &) const
	Raw value disregarding cutoff. More...

virtual double_t	raw_value (const Position< 3 > &, librandom::RngPtr &) const
	Raw value disregarding cutoff. More...

double_t	value (const std::vector< double_t > &pt, librandom::RngPtr &rng) const

virtual Parameter *	clone () const =0
	Clone method. More...

virtual Parameter *	multiply_parameter (const Parameter &other) const
	Create the product of this parameter with another. More...

virtual Parameter *	divide_parameter (const Parameter &other) const
	Create the quotient of this parameter with another. More...

virtual Parameter *	add_parameter (const Parameter &other) const
	Create the sum of this parameter with another. More...

virtual Parameter *	subtract_parameter (const Parameter &other) const
	Create the difference of this parameter with another. More...

Private Attributes
double_t	cutoff_

Detailed Description

Abstract base class for parameters.

Constructor & Destructor Documentation

nest::Parameter::Parameter ( )

inline

Default constructor.

nest::Parameter::Parameter ( double_t cutoff )

inline

Constructor.

Parameters

cutoff Values less than the cutoff are set to zero.

nest::Parameter::Parameter ( const DictionaryDatum & d )

inline

Constructor Parameter that can be set in the Dictionary: cutoff - Values less than the cutoff are set to zero.

Parameters

d	dictionary with parameter values

References nest::names::cutoff, cutoff_, and nest::names::d.

virtual nest::Parameter::~Parameter ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Parameter * nest::Parameter::add_parameter ( const Parameter & other ) const

inlinevirtual

Create the sum of this parameter with another.

Returns: a new dynamically allocated parameter.

virtual Parameter* nest::Parameter::clone ( ) const

pure virtual

Clone method.

Returns: dynamically allocated copy of parameter object

Implemented in nest::ConverseParameter, nest::DifferenceParameter, nest::SumParameter, nest::QuotientParameter, nest::ProductParameter, nest::AnchoredParameter< D >, nest::LognormalParameter, nest::NormalParameter, nest::UniformParameter, nest::Gaussian2DParameter, nest::GaussianParameter, nest::ExponentialParameter, nest::LinearParameter, and nest::ConstantParameter.

Parameter * nest::Parameter::divide_parameter ( const Parameter & other ) const

inlinevirtual

Create the quotient of this parameter with another.

Returns: a new dynamically allocated parameter.

Parameter * nest::Parameter::multiply_parameter ( const Parameter & other ) const

inlinevirtual

Create the product of this parameter with another.

Returns: a new dynamically allocated parameter.

virtual double_t nest::Parameter::raw_value	(	const Position< 2 > &	,
		librandom::RngPtr &
	)		const

inlinevirtual

Raw value disregarding cutoff.

Returns: the value of the parameter at the given point.

Reimplemented in nest::ConverseParameter, nest::DifferenceParameter, nest::SumParameter, nest::QuotientParameter, nest::ProductParameter, nest::LognormalParameter, nest::NormalParameter, nest::UniformParameter, nest::Gaussian2DParameter, nest::RadialParameter, and nest::ConstantParameter.

Referenced by nest::AnchoredParameter< D >::raw_value(), nest::ConverseParameter::raw_value(), and value().

virtual double_t nest::Parameter::raw_value	(	const Position< 3 > &	,
		librandom::RngPtr &
	)		const

inlinevirtual

Raw value disregarding cutoff.

Returns: the value of the parameter at the given point.

Reimplemented in nest::ConverseParameter, nest::DifferenceParameter, nest::SumParameter, nest::QuotientParameter, nest::ProductParameter, nest::LognormalParameter, nest::NormalParameter, nest::UniformParameter, nest::Gaussian2DParameter, nest::RadialParameter, and nest::ConstantParameter.

Parameter * nest::Parameter::subtract_parameter ( const Parameter & other ) const

inlinevirtual

Create the difference of this parameter with another.

Returns: a new dynamically allocated parameter.

double_t nest::Parameter::value	(	const Position< 2 > &	p,
		librandom::RngPtr &	rng
	)		const

inline

Returns: the value of the parameter at the given point.

References cutoff_, and raw_value().

Referenced by nest::ProductParameter::raw_value(), nest::QuotientParameter::raw_value(), nest::SumParameter::raw_value(), nest::DifferenceParameter::raw_value(), and value().

double_t nest::Parameter::value	(	const Position< 3 > &	p,
		librandom::RngPtr &	rng
	)		const

inline

Returns: the value of the parameter at the given point.

References cutoff_, and raw_value().

double_t nest::Parameter::value	(	const std::vector< double_t > &	pt,
		librandom::RngPtr &	rng
	)		const

Returns: the value of the parameter at the given point.

References value().

Member Data Documentation

double_t nest::Parameter::cutoff_

private

Referenced by Parameter(), and value().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation