nest::ConstantParameter Class Reference

Parameter with constant value. More...

#include <parameter.h>

Inheritance diagram for nest::ConstantParameter:

Collaboration diagram for nest::ConstantParameter:

Public Member Functions
	ConstantParameter (double value)
	Creates a ConstantParameter with a specified value.
	ConstantParameter (const Dictionary &d)
	Creates a ConstantParameter with the value specified in a dictionary.
	~ConstantParameter () override=default
double	value (RngPtr, Node *) override
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.

Private Attributes
double	value_

Additional Inherited Members
Protected Member Functions inherited from nest::Parameter
bool	value_is_integer_ (const double value) const
Protected Attributes inherited from nest::Parameter
bool	is_spatial_ { false }
bool	returns_int_only_ { false }

Detailed Description

Parameter with constant value.

Constructor & Destructor Documentation

ConstantParameter() [1/2]

nest::ConstantParameter::ConstantParameter ( double  value )

inlineexplicit

Creates a ConstantParameter with a specified value.

Parameters

value

parameter value

References nest::Parameter::returns_int_only_, value_, and nest::Parameter::value_is_integer_().

Here is the call graph for this function:

ConstantParameter() [2/2]

nest::ConstantParameter::ConstantParameter ( const Dictionary &  d )

inline

Creates a ConstantParameter with the value specified in a dictionary.

Parameters

d	dictionary with the parameter value

The dictionary must include the following entry: value - constant value of this parameter

References nest::Parameter::returns_int_only_, value_, and nest::Parameter::value_is_integer_().

Here is the call graph for this function:

~ConstantParameter()

nest::ConstantParameter::~ConstantParameter ( )

overridedefault

Member Function Documentation

value() [1/3]

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/3]

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() [3/3]

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

inlineoverridevirtual

Returns

the constant value of this parameter.

Reimplemented from nest::Parameter.

References value_.

Member Data Documentation

value_

double nest::ConstantParameter::value_

private

Referenced by ConstantParameter(), ConstantParameter(), and value().

---

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

• parameter.h