librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV > Class Template Reference

Wrapper template turning any discrete RDV into a clipped-to-boundary RDV. More...

#include <clipped_randomdev.h>

Inheritance diagram for librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >:

Public Member Functions
	ClippedToBoundaryDiscreteRandomDev (RngPtr)
	ClippedToBoundaryDiscreteRandomDev ()
double	operator() (void)
double	operator() (RngPtr) const
long	ldev (void)
long	ldev (RngPtr) const
void	set_status (const DictionaryDatum &)
	set distribution parameters from SLI dict More...
void	get_status (DictionaryDatum &) const
	get distribution parameters from SLI dict More...

Private Attributes
long	min_
	smallest value More...
long	max_
	largest value More...

Detailed Description

template<typename BaseRDV>
class librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >

Wrapper template turning any discrete RDV into a clipped-to-boundary RDV.

To-boundary RDVs return the boundary value if a number outside the interval is drawn. This is mainly for reproduction of existing models using this approach, it does not make much sense!

See also

ClippedToBoundaryContinuousRandomDev

Constructor & Destructor Documentation

template<typename BaseRDV >

librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::ClippedToBoundaryDiscreteRandomDev

(

RngPtr

r

)

References assert().

template<typename BaseRDV >

librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::ClippedToBoundaryDiscreteRandomDev

(

)

References assert().

Member Function Documentation

template<typename BaseRDV >

void librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::get_status

(

DictionaryDatum &

d

)

const

get distribution parameters from SLI dict

References nest::names::d.

template<typename BaseRDV >

long librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::ldev ( void  )

inline

template<typename BaseRDV >

long librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::ldev ( RngPtr  r ) const

inline

template<typename BaseRDV >

double librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::operator() ( void  )

inline

template<typename BaseRDV >

double librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::operator() ( RngPtr  r ) const

inline

template<typename BaseRDV >

void librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::set_status

(

const DictionaryDatum &

d

)

set distribution parameters from SLI dict

References nest::names::d.

Member Data Documentation

template<typename BaseRDV >

long librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::max_

private

largest value

template<typename BaseRDV >

long librandom::ClippedToBoundaryDiscreteRandomDev< BaseRDV >::min_

private

smallest value

---

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

• clipped_randomdev.h