NEST: librandom::UniformIntRandomDev Class Reference

NEST 2.6.0,not_revisioned_source_dir@0

Class UniformIntRandomDev Create uniformly distributed random integers from a given range. More...

#include <uniformint_randomdev.h>

Inheritance diagram for librandom::UniformIntRandomDev:

Public Member Functions
	UniformIntRandomDev (RngPtr r_in)

	UniformIntRandomDev ()

long	ldev (RngPtr) const
	draw integer, threaded More...

bool	has_ldev () const
	true if RDG implements ldev function More...

double	operator() (RngPtr rthrd) const
	multi-threaded More...

void	set_status (const DictionaryDatum &)
	set distribution parameters from SLI dict More...

void	get_status (DictionaryDatum &) const
	get distribution parameters from SLI dict More...

Public Member Functions inherited from librandom::RandomDev
	RandomDev (RngPtr rng=RngPtr(0))
	Construct with (single-threaded) or without (multithreaded) RNG. More...

virtual	~RandomDev ()
	ensure proper clean-up More...

virtual double	operator() (void)
	Operator delivering doubles. More...

virtual long	ldev (void)
	integer valued functions for discrete distributions More...

void	set_rng (RngPtr rng)
	set RNG More...

Private Attributes
long	nmin_
	smallest permissible number More...

long	nmax_
	largest permissible number More...

long	range_
	nmax_ - nmin_ + 1 More...

Additional Inherited Members
Protected Attributes inherited from librandom::RandomDev
RngPtr	rng_
	store underlying RNG More...

Detailed Description

Class UniformIntRandomDev Create uniformly distributed random integers from a given range.

Constructor & Destructor Documentation

librandom::UniformIntRandomDev::UniformIntRandomDev ( RngPtr r_in )

librandom::UniformIntRandomDev::UniformIntRandomDev ( )

Member Function Documentation

void librandom::UniformIntRandomDev::get_status ( DictionaryDatum & d ) const

virtual

get distribution parameters from SLI dict

Implements librandom::RandomDev.

References nest::names::d.

bool librandom::UniformIntRandomDev::has_ldev ( ) const

inlinevirtual

true if RDG implements ldev function

Reimplemented from librandom::RandomDev.

long librandom::UniformIntRandomDev::ldev ( RngPtr r_s ) const

inlinevirtual

draw integer, threaded

Reimplemented from librandom::RandomDev.

References assert(), nmin_, and range_.

double librandom::UniformIntRandomDev::operator() ( RngPtr ) const

inlinevirtual

multi-threaded

Implements librandom::RandomDev.

References librandom::RandomDev::ldev().

void librandom::UniformIntRandomDev::set_status ( const DictionaryDatum & d )

virtual

set distribution parameters from SLI dict

Implements librandom::RandomDev.

References nest::names::d, and nest::names::max.

Member Data Documentation

long librandom::UniformIntRandomDev::nmax_

private

largest permissible number

long librandom::UniformIntRandomDev::nmin_

private

smallest permissible number

Referenced by ldev().

long librandom::UniformIntRandomDev::range_

private

nmax_ - nmin_ + 1

Referenced by ldev().

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