nest::LognormalParameter Class Reference

Random parameter with lognormal distribution, optionally truncated to [min,max). More...

#include <parameter.h>

Inheritance diagram for nest::LognormalParameter:

Public Member Functions
	LognormalParameter (const DictionaryDatum &d)
	Parameters: mu - mean value of logarithm sigma - standard distribution of logarithm min - minimum value max - maximum value. More...
double_t	raw_value (librandom::RngPtr &rng) const
double_t	raw_value (const Position< 2 > &, librandom::RngPtr &rng) const
	Raw value disregarding cutoff. More...
double_t	raw_value (const Position< 3 > &, librandom::RngPtr &rng) const
	Raw value disregarding cutoff. More...
Parameter *	clone () const
	Clone method. More...
Public Member Functions inherited from nest::Parameter
	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
double_t	value (const std::vector< double_t > &pt, librandom::RngPtr &rng) const
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	mu_
double_t	sigma_
double_t	min_
double_t	max_
librandom::NormalRandomDev	rdev

Detailed Description

Random parameter with lognormal distribution, optionally truncated to [min,max).

Truncation is implemented by rejection.

Constructor & Destructor Documentation

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

inline

Parameters: mu - mean value of logarithm sigma - standard distribution of logarithm min - minimum value max - maximum value.

References nest::names::d, nest::names::max, max_, nest::names::min, min_, nest::names::mu, mu_, nest::names::sigma, and sigma_.

Referenced by clone().

Member Function Documentation

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

inlinevirtual

Clone method.

Returns

dynamically allocated copy of parameter object

Implements nest::Parameter.

References LognormalParameter().

double_t nest::LognormalParameter::raw_value ( librandom::RngPtr &  rng ) const

inline

References max_, min_, mu_, rdev, and sigma_.

Referenced by raw_value().

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

inlinevirtual

Raw value disregarding cutoff.

Returns

the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References raw_value().

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

inlinevirtual

Raw value disregarding cutoff.

Returns

the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References raw_value().

Member Data Documentation

double_t nest::LognormalParameter::max_

private

Referenced by LognormalParameter(), and raw_value().

double_t nest::LognormalParameter::min_

private

Referenced by LognormalParameter(), and raw_value().

double_t nest::LognormalParameter::mu_

private

Referenced by LognormalParameter(), and raw_value().

librandom::NormalRandomDev nest::LognormalParameter::rdev

private

Referenced by raw_value().

double_t nest::LognormalParameter::sigma_

private

Referenced by LognormalParameter(), and raw_value().

---

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

• parameter.h