Parameter class representing the maximum of a parameter's value and a given value. More...

#include <parameter.h>

Inheritance diagram for nest::MaxParameter:

Collaboration diagram for nest::MaxParameter:

Public Member Functions
	MaxParameter (ParameterPTR p, const double other_value)
	Construct a max parameter.

	MaxParameter (const MaxParameter &p)

double	value (RngPtr rng, Node *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.

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_

double	other_value_

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 the maximum of a parameter's value and a given value.

Constructor & Destructor Documentation

◆ MaxParameter() [1/2]

nest::MaxParameter::MaxParameter	(	ParameterPTR	p,
		const double	other_value
	)

inline

Construct a max parameter.

A copy is made of the supplied Parameter object.

◆ MaxParameter() [2/2]

nest::MaxParameter::MaxParameter ( const MaxParameter & p )

inline

Member Function Documentation

◆ value() [1/2]

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

inlineoverridevirtual

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 other_value_, and p_.

◆ value() [2/2]

double nest::MaxParameter::value	(	RngPtr	rng,
		Node *	node
	)

inlineoverridevirtual

Returns: the value of the parameter.

Reimplemented from nest::Parameter.

References other_value_, and p_.

Member Data Documentation

◆ other_value_

double nest::MaxParameter::other_value_

protected

Referenced by value(), and value().

◆ p_

ParameterPTR const nest::MaxParameter::p_