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

Parameter class representing the sum of two parameters. More...

#include <parameter.h>

Inheritance diagram for nest::SumParameter:
nest::Parameter

Public Member Functions

 SumParameter (const Parameter &m1, const Parameter &m2)
 Construct the sum of the two given parameters. More...
 
 SumParameter (const SumParameter &p)
 Copy constructor. More...
 
 ~SumParameter ()
 
double_t raw_value (const Position< 2 > &p, librandom::RngPtr &rng) const
 
double_t raw_value (const Position< 3 > &p, 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...
 

Protected Attributes

Parameterparameter1_
 
Parameterparameter2_
 

Detailed Description

Parameter class representing the sum of two parameters.

Constructor & Destructor Documentation

nest::SumParameter::SumParameter ( const Parameter m1,
const Parameter m2 
)
inline

Construct the sum of the two given parameters.

Copies are made of the supplied Parameter objects.

Referenced by clone().

nest::SumParameter::SumParameter ( const SumParameter p)
inline

Copy constructor.

nest::SumParameter::~SumParameter ( )
inline

References parameter1_, and parameter2_.

Member Function Documentation

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

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References SumParameter().

double_t nest::SumParameter::raw_value ( const Position< 2 > &  p,
librandom::RngPtr rng 
) const
inlinevirtual
Returns
the value of the sum.

Reimplemented from nest::Parameter.

References parameter1_, parameter2_, and nest::Parameter::value().

double_t nest::SumParameter::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 parameter1_, parameter2_, and nest::Parameter::value().

Member Data Documentation

Parameter* nest::SumParameter::parameter1_
protected

Referenced by raw_value(), and ~SumParameter().

Parameter * nest::SumParameter::parameter2_
protected

Referenced by raw_value(), and ~SumParameter().


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