Parameter class representing the quotient of two parameters. More...
#include <parameter.h>
Inheritance diagram for nest::QuotientParameter:
Public Member Functions | |
| QuotientParameter (const Parameter &m1, const Parameter &m2) | |
| Construct the quotient of the two given parameters. More... | |
| QuotientParameter (const QuotientParameter &p) | |
| Copy constructor. More... | |
| ~QuotientParameter () | |
| 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... | |
| Parameter * | clone () 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 Parameter * | multiply_parameter (const Parameter &other) const |
| Create the product of this parameter with another. More... | |
| virtual Parameter * | divide_parameter (const Parameter &other) const |
| Create the quotient of this parameter with another. More... | |
| virtual Parameter * | add_parameter (const Parameter &other) const |
| Create the sum of this parameter with another. More... | |
| virtual Parameter * | subtract_parameter (const Parameter &other) const |
| Create the difference of this parameter with another. More... | |
Protected Attributes | |
| Parameter * | parameter1_ |
| Parameter * | parameter2_ |
Detailed Description
Parameter class representing the quotient of two parameters.
Constructor & Destructor Documentation
|
inline |
Copy constructor.
|
inline |
References parameter1_, and parameter2_.
Member Function Documentation
|
inlinevirtual |
Clone method.
- Returns
- dynamically allocated copy of parameter object
Implements nest::Parameter.
References QuotientParameter().
|
inlinevirtual |
- Returns
- the value of the product.
Reimplemented from nest::Parameter.
References parameter1_, parameter2_, and nest::Parameter::value().
|
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
|
protected |
Referenced by raw_value(), and ~QuotientParameter().
|
protected |
Referenced by raw_value(), and ~QuotientParameter().
The documentation for this class was generated from the following file:
