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

Array parameter, returning values in order. More...

#include <conn_parameter.h>

Inheritance diagram for nest::ArrayParameter:
nest::ConnParameter

Public Member Functions

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

Private Attributes

std::vector< double > values_
 
std::vector< double >::iterator next_
 

Additional Inherited Members

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

Detailed Description

Array parameter, returning values in order.

Constructor & Destructor Documentation

nest::ArrayParameter::ArrayParameter ( const std::vector< double > &  values)
inline

Member Function Documentation

size_t nest::ArrayParameter::number_of_values ( ) const
inlinevirtual

Returns number of values available.

0 indicates scalar/unlimited supply.

Reimplemented from nest::ConnParameter.

References values_.

double nest::ArrayParameter::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 next_, and values_.

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

Implements nest::ConnParameter.

Member Data Documentation

std::vector<double>::iterator nest::ArrayParameter::next_
mutableprivate

Referenced by value_double().

std::vector<double> nest::ArrayParameter::values_
private

Referenced by number_of_values(), and value_double().


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