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

Exponential parameter p(d) = c + a*exp(-d/tau). More...

#include <parameter.h>

Inheritance diagram for nest::ExponentialParameter:
nest::RadialParameter nest::Parameter

Public Member Functions

 ExponentialParameter (const DictionaryDatum &d)
 Parameters: a - coefficient of exponential term tau - length scale factor c - constant offset. More...
 
double_t raw_value (double_t x) const
 
Parameterclone () const
 Clone method. More...
 
- Public Member Functions inherited from nest::RadialParameter
 RadialParameter ()
 
 RadialParameter (double_t cutoff)
 
 RadialParameter (const DictionaryDatum &d)
 
double_t raw_value (const Position< 2 > &p, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
double_t raw_value (const Position< 3 > &p, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
- Public Member Functions inherited from nest::Parameter
 Parameter ()
 Default constructor. More...
 
 Parameter (double_t cutoff)
 Constructor. More...
 
 Parameter (const DictionaryDatum &d)
 Constructor Parameter that can be set in the Dictionary: cutoff - Values less than the cutoff are set to zero. More...
 
virtual ~Parameter ()
 Virtual destructor. More...
 
double_t value (const Position< 2 > &p, librandom::RngPtr &rng) const
 
double_t value (const Position< 3 > &p, librandom::RngPtr &rng) const
 
double_t value (const std::vector< double_t > &pt, librandom::RngPtr &rng) const
 
virtual Parametermultiply_parameter (const Parameter &other) const
 Create the product of this parameter with another. More...
 
virtual Parameterdivide_parameter (const Parameter &other) const
 Create the quotient of this parameter with another. More...
 
virtual Parameteradd_parameter (const Parameter &other) const
 Create the sum of this parameter with another. More...
 
virtual Parametersubtract_parameter (const Parameter &other) const
 Create the difference of this parameter with another. More...
 

Private Attributes

double_t a_
 
double_t c_
 
double_t tau_
 

Detailed Description

Exponential parameter p(d) = c + a*exp(-d/tau).

Constructor & Destructor Documentation

nest::ExponentialParameter::ExponentialParameter ( const DictionaryDatum d)
inline

Parameters: a - coefficient of exponential term tau - length scale factor c - constant offset.

References nest::names::a, a_, nest::names::c, c_, nest::names::d, nest::names::tau, and tau_.

Referenced by clone().

Member Function Documentation

Parameter* nest::ExponentialParameter::clone ( ) const
inlinevirtual

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References ExponentialParameter().

double_t nest::ExponentialParameter::raw_value ( double_t  x) const
inlinevirtual

Implements nest::RadialParameter.

References a_, c_, and tau_.

Member Data Documentation

double_t nest::ExponentialParameter::a_
private

Referenced by ExponentialParameter(), and raw_value().

double_t nest::ExponentialParameter::c_
private

Referenced by ExponentialParameter(), and raw_value().

double_t nest::ExponentialParameter::tau_
private

Referenced by ExponentialParameter(), and raw_value().


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