NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | List of all members
nest::RadialParameter Class Referenceabstract

Abstract base class for parameters only depending on distance. More...

#include <parameter.h>

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

Public Member Functions

 RadialParameter ()
 
 RadialParameter (double_t cutoff)
 
 RadialParameter (const DictionaryDatum &d)
 
virtual double_t raw_value (double_t) const =0
 
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 Parameterclone () const =0
 Clone method. More...
 
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...
 

Detailed Description

Abstract base class for parameters only depending on distance.

Constructor & Destructor Documentation

nest::RadialParameter::RadialParameter ( )
inline
nest::RadialParameter::RadialParameter ( double_t  cutoff)
inline
nest::RadialParameter::RadialParameter ( const DictionaryDatum d)
inline

Member Function Documentation

virtual double_t nest::RadialParameter::raw_value ( double_t  ) const
pure virtual
double_t nest::RadialParameter::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 nest::Position< D, T >::length(), and raw_value().

double_t nest::RadialParameter::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 nest::Position< D, T >::length(), and raw_value().


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