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

Random parameter with uniform distribution in [min,max) More...

#include <parameter.h>

Inheritance diagram for nest::UniformParameter:
nest::Parameter

Public Member Functions

 UniformParameter (const DictionaryDatum &d)
 Parameters: min - minimum value max - maximum value. More...
 
double_t raw_value (const Position< 2 > &, librandom::RngPtr &rng) const
 Raw value disregarding cutoff. More...
 
double_t raw_value (const Position< 3 > &, librandom::RngPtr &rng) const
 Raw value disregarding cutoff. More...
 
Parameterclone () const
 Clone method. 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 lower_
 
double_t range_
 

Detailed Description

Random parameter with uniform distribution in [min,max)

Constructor & Destructor Documentation

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

Parameters: min - minimum value max - maximum value.

References nest::names::d, lower_, nest::names::max, nest::names::min, and range_.

Referenced by clone().

Member Function Documentation

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

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References UniformParameter().

double_t nest::UniformParameter::raw_value ( const Position< 2 > &  ,
librandom::RngPtr  
) const
inlinevirtual

Raw value disregarding cutoff.

Returns
the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References lower_, and range_.

double_t nest::UniformParameter::raw_value ( const Position< 3 > &  ,
librandom::RngPtr  
) const
inlinevirtual

Raw value disregarding cutoff.

Returns
the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References lower_, and range_.

Member Data Documentation

double_t nest::UniformParameter::lower_
private

Referenced by raw_value(), and UniformParameter().

double_t nest::UniformParameter::range_
private

Referenced by raw_value(), and UniformParameter().


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