nest::GammaParameter Class Reference

Parameter class representing a gamma distribution applied on a parameter. More...

#include <parameter.h>

Inheritance diagram for nest::GammaParameter:

Collaboration diagram for nest::GammaParameter:

Public Member Functions
	GammaParameter (const Dictionary &d)
	Construct the parameter from a dictionary of arguments.
	GammaParameter (const GammaParameter &p)
double	value (RngPtr, Node *) override
double	value (RngPtr rng, const std::vector< double > &source_pos, const std::vector< double > &target_pos, const AbstractLayer &layer, Node *node) override
	Generates a value based on parameter specifications and arguments.
virtual double	value (RngPtr, Node *)
	Generates a value based on parameter specifications and arguments.
virtual double	value (RngPtr rng, const std::vector< double > &source_pos, const std::vector< double > &target_pos, const AbstractLayer &layer, Node *node)
	Generates a value based on parameter specifications and arguments.
Public Member Functions inherited from nest::Parameter
	Parameter (bool is_spatial=false, bool returns_int_only=false)
	Creates a Parameter, with optionally specified attributes.
	Parameter (const Parameter &p)=default
virtual	~Parameter ()=default
std::vector< double >	apply (const NodeCollectionPTR &, const std::vector< std::vector< double > > &)
	Applies a parameter on a single-node ID NodeCollection and given array of positions.
bool	is_spatial () const
	Check if the Parameter is based on spatial properties.
bool	returns_int_only () const
	Check if the Parameter only returns integer values.

Protected Attributes
ParameterPTR const	p_
const double	kappa_
const double	inv_theta_
const double	delta_
Protected Attributes inherited from nest::Parameter
bool	is_spatial_ { false }
bool	returns_int_only_ { false }

Additional Inherited Members
Protected Member Functions inherited from nest::Parameter
bool	value_is_integer_ (const double value) const

Detailed Description

Parameter class representing a gamma distribution applied on a parameter.

Can only be used when connecting spatially distributed nodes.

Constructor & Destructor Documentation

GammaParameter() [1/2]

nest::GammaParameter::GammaParameter

(

const Dictionary &

d

)

Construct the parameter from a dictionary of arguments.

References kappa_.

GammaParameter() [2/2]

nest::GammaParameter::GammaParameter ( const GammaParameter &  p )

inline

Member Function Documentation

value() [1/4]

double nest::Parameter::value ( RngPtr  rng, const std::vector< double > &  source_pos, const std::vector< double > &  target_pos, const AbstractLayer &  layer, Node *  node  )

inlinevirtual

Generates a value based on parameter specifications and arguments.

Used when connecting spatial nodes. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
source_pos	position of the source node
target_pos	position of the target node
layer	spatial layer
node	target node, required for normal and lognormal parameters

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

value() [2/4]

double nest::GammaParameter::value ( RngPtr  rng, const std::vector< double > &  source_pos, const std::vector< double > &  target_pos, const AbstractLayer &  layer, Node *  node  )

overridevirtual

Generates a value based on parameter specifications and arguments.

Used when connecting spatial nodes. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
source_pos	position of the source node
target_pos	position of the target node
layer	spatial layer
node	target node, required for normal and lognormal parameters

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

References delta_, inv_theta_, kappa_, and p_.

value() [3/4]

virtual double nest::Parameter::value ( RngPtr  , Node *    )

inlinevirtual

Generates a value based on parameter specifications and arguments.

Used when getting a parameter value based on random values or node attributes, like position. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
node	pointer to the node, used when the node position is relevant

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

value() [4/4]

double nest::GammaParameter::value ( RngPtr  , Node *    )

inlineoverridevirtual

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

Member Data Documentation

delta_

const double nest::GammaParameter::delta_

protected

Referenced by value().

inv_theta_

const double nest::GammaParameter::inv_theta_

protected

Referenced by value().

kappa_

const double nest::GammaParameter::kappa_

protected

Referenced by GammaParameter(), and value().

p_

ParameterPTR const nest::GammaParameter::p_

protected

Referenced by value().

---

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

• parameter.h
• parameter.cpp