Parameter representing the spatial distance between two nodes, optionally in a specific dimension. More...

#include <parameter.h>

Inheritance diagram for nest::SpatialDistanceParameter:

Collaboration diagram for nest::SpatialDistanceParameter:

Public Member Functions
	SpatialDistanceParameter (const Dictionary &d)

double	value (RngPtr, Node *) override
	Generates a value based on parameter specifications and arguments.

double	value (RngPtr rng, const std::vector< double > &source_pos, const std::vector< double > &target_pos, const AbstractLayer &layer, 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.

Private Attributes
int	dimension_

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 representing the spatial distance between two nodes, optionally in a specific dimension.

Constructor & Destructor Documentation

◆ SpatialDistanceParameter()

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

inline

References nest::names::dimension(), and dimension_.

Here is the call graph for this function:

Member Function Documentation

◆ value() [1/2]

double nest::SpatialDistanceParameter::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 nest::AbstractLayer::compute_displacement(), nest::AbstractLayer::compute_distance(), dimension_, and nest::AbstractLayer::get_num_dimensions().

Here is the call graph for this function:

◆ value() [2/2]

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

inlineoverridevirtual

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.

Member Data Documentation

◆ dimension_

int nest::SpatialDistanceParameter::dimension_

private

Referenced by SpatialDistanceParameter(), and value().

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

	NEST main@caf0ae8

Public Member Functions

Private Attributes

Additional Inherited Members