NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Attributes | List of all members
nest::RandomParameter Class Reference

Random scalar value. More...

#include <conn_parameter.h>

Inheritance diagram for nest::RandomParameter:
nest::ConnParameter

Public Member Functions

 RandomParameter (const DictionaryDatum &)
 
double value_double (index, index, librandom::RngPtr &rng) const
 Return parameter value. More...
 
long_t value_int (index, index, librandom::RngPtr &rng) const
 
- Public Member Functions inherited from nest::ConnParameter
 ConnParameter ()
 
virtual ~ConnParameter ()
 
virtual size_t number_of_values () const
 Returns number of values available. More...
 

Private Attributes

librandom::RdvPtr rdv_
 

Additional Inherited Members

- Static Public Member Functions inherited from nest::ConnParameter
static ConnParametercreate (const Token &)
 

Detailed Description

Random scalar value.

On each request, it returns a new value drawn from the given deviate.

Constructor & Destructor Documentation

nest::RandomParameter::RandomParameter ( const DictionaryDatum rdv_spec)

Member Function Documentation

double nest::RandomParameter::value_double ( index  ,
index  ,
librandom::RngPtr  
) const
inlinevirtual

Return parameter value.

The parameter value may depend on source and target GIDs (when using callback functions, not yet implemented) and random numbers. All three must be supplied, even if a concrete parameter type does not use them.

Parameters
sgidsource gid
tgidtarget gid
rngrandom number generator pointer will be ignored except for random parameters.

Implements nest::ConnParameter.

References rdv_.

long_t nest::RandomParameter::value_int ( index  ,
index  ,
librandom::RngPtr rng 
) const
inlinevirtual

Implements nest::ConnParameter.

References rdv_.

Member Data Documentation

librandom::RdvPtr nest::RandomParameter::rdv_
private

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