#include "oct-rand.h"

Collaboration diagram for octave::rand:

[legend]

Public Member Functions
	~rand (void)=default

Static Public Member Functions
static void	distribution (const std::string &d)

static std::string	distribution (void)

static void	exponential_distribution (void)

static FloatNDArray	float_nd_array (const dim_vector &dims, float a=1.0)

static float	float_scalar (float a=1.0)

static Array< float >	float_vector (octave_idx_type n, float a=1.0)

static void	gamma_distribution (void)

static bool	instance_ok (void)

static NDArray	nd_array (const dim_vector &dims, double a=1.0)

static void	normal_distribution (void)

static void	poisson_distribution (void)

static void	reset (const std::string &d)

static void	reset (void)

static double	scalar (double a=1.0)

static void	seed (double s)

static double	seed (void)

static uint32NDArray	state (const std::string &d="")

static void	state (const uint32NDArray &s, const std::string &d="")

static void	uniform_distribution (void)

static Array< double >	vector (octave_idx_type n, double a=1.0)

Protected Member Functions
	rand (void)

Private Types
enum	{ unknown_dist , uniform_dist , normal_dist , expon_dist , poisson_dist , gamma_dist }

Private Member Functions
void	do_distribution (const std::string &d)

std::string	do_distribution (void)

void	do_exponential_distribution (void)

FloatNDArray	do_float_nd_array (const dim_vector &dims, float a=1.)

void	do_gamma_distribution (void)

NDArray	do_nd_array (const dim_vector &dims, double a=1.)

void	do_normal_distribution (void)

void	do_poisson_distribution (void)

void	do_reset ()

void	do_reset (const std::string &d)

template<typename T >
T	do_scalar (T a=1)

void	do_seed (double s)

double	do_seed (void)

uint32NDArray	do_state (const std::string &d)

void	do_state (const uint32NDArray &s, const std::string &d)

void	do_uniform_distribution (void)

template<typename T >
Array< T >	do_vector (octave_idx_type n, T a=1)

template<>
double	exponential (void)

template<>
float	exponential (void)

template<typename T >
T	exponential (void)

void	fill (octave_idx_type len, double *v, double a)

void	fill (octave_idx_type len, float *v, float a)

template<>
double	gamma (double a)

template<>
float	gamma (float a)

template<typename T >
T	gamma (T a)

int	get_dist_id (const std::string &d)

uint32NDArray	get_internal_state (void)

void	initialize_mersenne_twister (void)

void	initialize_ranlib_generators (void)

template<>
double	normal (void)

template<>
float	normal (void)

template<typename T >
T	normal (void)

template<>
double	poisson (double a)

template<>
float	poisson (float a)

template<typename T >
T	poisson (T a)

void	save_state (void)

void	set_internal_state (const uint32NDArray &s)

void	switch_to_generator (int dist)

template<>
double	uniform (void)

template<>
float	uniform (void)

template<typename T >
T	uniform (void)

Static Private Member Functions
static void	cleanup_instance (void)

Private Attributes
int	current_distribution

std::map< int, uint32NDArray >	rand_states

bool	use_old_generators

Static Private Attributes
static rand *	instance = nullptr

Detailed Description

Definition at line 44 of file oct-rand.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
unknown_dist
uniform_dist
normal_dist
expon_dist
poisson_dist
gamma_dist

Definition at line 189 of file oct-rand.h.

Constructor & Destructor Documentation

◆ rand()

octave::rand::rand ( void )

protected

Definition at line 53 of file oct-rand.cc.

References initialize_mersenne_twister(), and initialize_ranlib_generators().

Referenced by instance_ok().

◆ ~rand()

octave::rand::~rand ( void )

default

Member Function Documentation

◆ cleanup_instance()

static void octave::rand::cleanup_instance ( void )

inlinestaticprivate

Definition at line 187 of file oct-rand.h.

Referenced by instance_ok().

◆ distribution() [1/2]

static void octave::rand::distribution ( const std::string & d )

inlinestatic

Definition at line 106 of file oct-rand.h.

References d.

◆ distribution() [2/2]

static std::string octave::rand::distribution ( void )

inlinestatic

Definition at line 99 of file oct-rand.h.

Referenced by do_rand(), EigsComplexNonSymmetricFunc(), EigsComplexNonSymmetricMatrix(), EigsComplexNonSymmetricMatrixShift(), EigsRealNonSymmetricFunc(), EigsRealNonSymmetricMatrix(), EigsRealNonSymmetricMatrixShift(), EigsRealSymmetricFunc(), EigsRealSymmetricMatrix(), and EigsRealSymmetricMatrixShift().

◆ do_distribution() [1/2]

void octave::rand::do_distribution ( const std::string & d )

private

Definition at line 225 of file oct-rand.cc.

References d, expon_dist, exponential_distribution(), gamma_dist, gamma_distribution(), get_dist_id(), normal_dist, normal_distribution(), poisson_dist, poisson_distribution(), uniform_dist, and uniform_distribution().

◆ do_distribution() [2/2]

std::string octave::rand::do_distribution ( void )

private

Definition at line 190 of file oct-rand.cc.

References current_distribution, expon_dist, gamma_dist, normal_dist, poisson_dist, retval, and uniform_dist.

◆ do_exponential_distribution()

void octave::rand::do_exponential_distribution ( void )

private

Definition at line 272 of file oct-rand.cc.

References expon_dist, F77_FUNC(), and switch_to_generator().

◆ do_float_nd_array()

FloatNDArray octave::rand::do_float_nd_array	(	const dim_vector &	dims,
		float	a = `1.`
	)

private

Definition at line 531 of file oct-rand.cc.

References dim_vector::all_zero(), Array< T >::clear(), fill(), Array< T >::fortran_vec(), Array< T >::numel(), and retval.

◆ do_gamma_distribution()

void octave::rand::do_gamma_distribution ( void )

private

Definition at line 286 of file oct-rand.cc.

References F77_FUNC(), gamma_dist, and switch_to_generator().

◆ do_nd_array()

NDArray octave::rand::do_nd_array	(	const dim_vector &	dims,
		double	a = `1.`
	)

private

Definition at line 517 of file oct-rand.cc.

References dim_vector::all_zero(), Array< T >::clear(), fill(), Array< T >::fortran_vec(), Array< T >::numel(), and retval.

◆ do_normal_distribution()

void octave::rand::do_normal_distribution ( void )

private

Definition at line 265 of file oct-rand.cc.

References F77_FUNC(), normal_dist, and switch_to_generator().

◆ do_poisson_distribution()

void octave::rand::do_poisson_distribution ( void )

private

Definition at line 279 of file oct-rand.cc.

References F77_FUNC(), poisson_dist, and switch_to_generator().

◆ do_reset() [1/2]

void octave::rand::do_reset ( void )

private

Definition at line 138 of file oct-rand.cc.

References initialize_ranlib_generators(), and use_old_generators.

◆ do_reset() [2/2]

void octave::rand::do_reset ( const std::string & d )

private

Definition at line 170 of file oct-rand.cc.

References current_distribution, d, get_dist_id(), get_internal_state(), octave::init_mersenne_twister(), rand_states, and use_old_generators.

◆ do_scalar()

template<typename T >

template float octave::rand::do_scalar< float > ( T a = 1 )

private

Definition at line 455 of file oct-rand.cc.

References current_distribution, expon_dist, gamma_dist, normal_dist, poisson_dist, retval, save_state(), uniform_dist, and use_old_generators.

◆ do_seed() [1/2]

void octave::rand::do_seed ( double s )

private

Definition at line 111 of file oct-rand.cc.

References d, F77_FUNC(), octave::mach_info::flt_fmt_ieee_big_endian, octave::force_to_fit_range(), octave::mach_info::native_float_format(), setsd(), and use_old_generators.

◆ do_seed() [2/2]

double octave::rand::do_seed ( void )

private

Definition at line 75 of file oct-rand.cc.

References d, F77_FUNC(), octave::mach_info::flt_fmt_ieee_big_endian, getsd(), and octave::mach_info::native_float_format().

◆ do_state() [1/2]

uint32NDArray octave::rand::do_state ( const std::string & d )

private

Definition at line 144 of file oct-rand.cc.

References current_distribution, d, get_dist_id(), and rand_states.

◆ do_state() [2/2]

void octave::rand::do_state	(	const uint32NDArray &	s,
		const std::string &	d
	)

private

Definition at line 149 of file oct-rand.cc.

References current_distribution, d, get_dist_id(), get_internal_state(), rand_states, set_internal_state(), and use_old_generators.

◆ do_uniform_distribution()

void octave::rand::do_uniform_distribution ( void )

private

Definition at line 258 of file oct-rand.cc.

References F77_FUNC(), switch_to_generator(), and uniform_dist.

◆ do_vector()

template<typename T >

template Array< float > octave::rand::do_vector< float >	(	octave_idx_type	n,
		T	a = `1`
	)

private

Definition at line 498 of file oct-rand.cc.

References Array< T >::clear(), fill(), Array< T >::fortran_vec(), n, Array< T >::numel(), and retval.

◆ exponential() [1/3]

template<>

double octave::rand::exponential ( void )

private

Definition at line 320 of file oct-rand.cc.

References dgenexp(), F77_FUNC(), octave::rand_exponential< double >(), retval, and use_old_generators.

◆ exponential() [2/3]

template<>

float octave::rand::exponential ( void )

private

Definition at line 399 of file oct-rand.cc.

References F77_FUNC(), fgenexp(), octave::rand_exponential< float >(), retval, and use_old_generators.

◆ exponential() [3/3]

template<typename T >

T octave::rand::exponential ( void )

private

◆ exponential_distribution()

static void octave::rand::exponential_distribution ( void )

inlinestatic

Definition at line 124 of file oct-rand.h.

Referenced by do_distribution(), and do_rand().

◆ fill() [1/2]

void octave::rand::fill	(	octave_idx_type	len,
		double *	v,
		double	a
	)

private

Definition at line 656 of file oct-rand.cc.

References current_distribution, dgenexp(), dgengam(), dgennor(), dgenunf(), dignpoi(), expon_dist, F77_FUNC(), gamma_dist, octave::math::isfinite(), len, NaN, normal_dist, poisson_dist, octave::rand_exponential< double >(), octave::rand_normal< double >(), octave::rand_poisson< double >(), octave::rand_uniform< double >(), save_state(), uniform_dist, use_old_generators, and x.

Referenced by do_float_nd_array(), do_nd_array(), and do_vector().

◆ fill() [2/2]

void octave::rand::fill	(	octave_idx_type	len,
		float *	v,
		float	a
	)

private

Definition at line 724 of file oct-rand.cc.

References current_distribution, expon_dist, F77_FUNC(), fgenexp(), fgengam(), fgennor(), fgenunf(), fignpoi(), gamma_dist, octave::math::isfinite(), len, NaN, normal_dist, poisson_dist, octave::rand_exponential< float >(), octave::rand_normal< float >(), octave::rand_poisson< float >(), octave::rand_uniform< float >(), save_state(), uniform_dist, use_old_generators, and x.

◆ float_nd_array()

static FloatNDArray octave::rand::float_nd_array	(	const dim_vector &	dims,
		float	a = `1.0`
	)

inlinestatic

Definition at line 177 of file oct-rand.h.

Referenced by do_rand().

◆ float_scalar()

static float octave::rand::float_scalar ( float a = 1.0 )

inlinestatic

Definition at line 150 of file oct-rand.h.

References NaN.

Referenced by do_rand().

◆ float_vector()

static Array<float> octave::rand::float_vector	(	octave_idx_type	n,
		float	a = `1.0`
	)

inlinestatic

Definition at line 163 of file oct-rand.h.

References Array< float >, and n.

◆ gamma() [1/3]

template<>

double octave::rand::gamma ( double a )

private

Definition at line 355 of file oct-rand.cc.

References dgengam(), F77_FUNC(), octave::math::isfinite(), NaN, retval, and use_old_generators.

◆ gamma() [2/3]

template<>

float octave::rand::gamma ( float a )

private

Definition at line 437 of file oct-rand.cc.

References F77_FUNC(), fgengam(), octave::math::isfinite(), NaN, retval, and use_old_generators.

◆ gamma() [3/3]

template<typename T >

T octave::rand::gamma ( T a )

private

◆ gamma_distribution()

static void octave::rand::gamma_distribution ( void )

inlinestatic

Definition at line 136 of file oct-rand.h.

Referenced by do_distribution(), and do_rand().

◆ get_dist_id()

int octave::rand::get_dist_id ( const std::string & d )

private

Definition at line 613 of file oct-rand.cc.

References current_liboctave_error_handler, d, expon_dist, gamma_dist, normal_dist, poisson_dist, retval, uniform_dist, and unknown_dist.

Referenced by do_distribution(), do_reset(), and do_state().

◆ get_internal_state()

uint32NDArray octave::rand::get_internal_state ( void )

private

Definition at line 599 of file oct-rand.cc.

References Array< T >::fortran_vec(), octave::get_mersenne_twister_state(), and MT_N.

Referenced by do_reset(), do_state(), initialize_mersenne_twister(), and save_state().

◆ initialize_mersenne_twister()

void octave::rand::initialize_mersenne_twister ( void )

private

Definition at line 570 of file oct-rand.cc.

References current_distribution, expon_dist, gamma_dist, get_internal_state(), octave::init_mersenne_twister(), normal_dist, poisson_dist, rand_states, set_internal_state(), and uniform_dist.

Referenced by rand().

◆ initialize_ranlib_generators()

void octave::rand::initialize_ranlib_generators ( void )

private

Definition at line 550 of file oct-rand.cc.

References current_distribution, F77_FUNC(), octave::force_to_fit_range(), octave::sys::base_tm::hour(), octave::sys::base_tm::mday(), octave::sys::base_tm::min(), octave::sys::base_tm::sec(), setall(), and uniform_dist.

Referenced by rand(), and do_reset().

◆ instance_ok()

bool octave::rand::instance_ok ( void )

static

Definition at line 62 of file oct-rand.cc.

References rand(), singleton_cleanup_list::add(), cleanup_instance(), instance, and retval.

◆ nd_array()

static NDArray octave::rand::nd_array	(	const dim_vector &	dims,
		double	a = `1.0`
	)

inlinestatic

Definition at line 170 of file oct-rand.h.

Referenced by do_rand(), and Frandperm().

◆ normal() [1/3]

template<>

double octave::rand::normal ( void )

private

Definition at line 307 of file oct-rand.cc.

References dgennor(), F77_FUNC(), octave::rand_normal< double >(), retval, and use_old_generators.

◆ normal() [2/3]

template<>

float octave::rand::normal ( void )

private

Definition at line 386 of file oct-rand.cc.

References F77_FUNC(), fgennor(), octave::rand_normal< float >(), retval, and use_old_generators.

◆ normal() [3/3]

template<typename T >

T octave::rand::normal ( void )

private

◆ normal_distribution()

static void octave::rand::normal_distribution ( void )

inlinestatic

Definition at line 118 of file oct-rand.h.

Referenced by do_distribution(), and do_rand().

◆ poisson() [1/3]

template<>

double octave::rand::poisson ( double a )

private

Definition at line 333 of file oct-rand.cc.

References dignpoi(), F77_FUNC(), octave::math::isfinite(), NaN, octave::rand_poisson< double >(), retval, and use_old_generators.

◆ poisson() [2/3]

template<>

float octave::rand::poisson ( float a )

private

Definition at line 412 of file oct-rand.cc.

References F77_FUNC(), fignpoi(), octave::math::isfinite(), NaN, octave::rand_poisson< double >(), retval, and use_old_generators.

◆ poisson() [3/3]

template<typename T >

T octave::rand::poisson ( T a )

private

◆ poisson_distribution()

static void octave::rand::poisson_distribution ( void )

inlinestatic

Definition at line 130 of file oct-rand.h.

Referenced by do_distribution(), and do_rand().

◆ reset() [1/2]

static void octave::rand::reset ( const std::string & d )

inlinestatic

Definition at line 92 of file oct-rand.h.

References d.

◆ reset() [2/2]

static void octave::rand::reset ( void )

inlinestatic

Definition at line 71 of file oct-rand.h.

Referenced by do_rand().

◆ save_state()

void octave::rand::save_state ( void )

private

Definition at line 608 of file oct-rand.cc.

References current_distribution, get_internal_state(), and rand_states.

Referenced by do_scalar(), and fill().

◆ scalar()

static double octave::rand::scalar ( double a = 1.0 )

inlinestatic

Definition at line 143 of file oct-rand.h.

References NaN.

Referenced by do_rand().

◆ seed() [1/2]

static void octave::rand::seed ( double s )

inlinestatic

Definition at line 64 of file oct-rand.h.

◆ seed() [2/2]

static double octave::rand::seed ( void )

inlinestatic

Definition at line 57 of file oct-rand.h.

References NaN.

Referenced by do_rand().

◆ set_internal_state()

void octave::rand::set_internal_state ( const uint32NDArray & s )

private

Definition at line 634 of file oct-rand.cc.

References Array< T >::data(), octave::init_mersenne_twister(), len, MT_N, Array< T >::numel(), and octave::set_mersenne_twister_state().

Referenced by do_state(), initialize_mersenne_twister(), and switch_to_generator().

◆ state() [1/2]

static uint32NDArray octave::rand::state ( const std::string & d = "" )

inlinestatic

Definition at line 78 of file oct-rand.h.

References d.

Referenced by do_rand().

◆ state() [2/2]

static void octave::rand::state	(	const uint32NDArray &	s,
		const std::string &	d = `""`
	)

inlinestatic

Definition at line 84 of file oct-rand.h.

References d.

◆ switch_to_generator()

void octave::rand::switch_to_generator ( int dist )

private

Definition at line 646 of file oct-rand.cc.

References current_distribution, rand_states, and set_internal_state().

Referenced by do_exponential_distribution(), do_gamma_distribution(), do_normal_distribution(), do_poisson_distribution(), and do_uniform_distribution().

◆ uniform() [1/3]

template<>

double octave::rand::uniform ( void )

private

Definition at line 294 of file oct-rand.cc.

References dgenunf(), F77_FUNC(), octave::rand_uniform< double >(), retval, and use_old_generators.

◆ uniform() [2/3]

template<>

float octave::rand::uniform ( void )

private

Definition at line 373 of file oct-rand.cc.

References F77_FUNC(), fgenunf(), octave::rand_uniform< float >(), retval, and use_old_generators.

◆ uniform() [3/3]

template<typename T >

T octave::rand::uniform ( void )

private

◆ uniform_distribution()

static void octave::rand::uniform_distribution ( void )

inlinestatic

Definition at line 112 of file oct-rand.h.

Referenced by do_distribution(), and do_rand().

◆ vector()

static Array<double> octave::rand::vector	(	octave_idx_type	n,
		double	a = `1.0`
	)

inlinestatic

Definition at line 157 of file oct-rand.h.

References Array< double >, and n.

Referenced by EigsComplexNonSymmetricFunc(), EigsComplexNonSymmetricMatrix(), EigsComplexNonSymmetricMatrixShift(), EigsRealNonSymmetricFunc(), EigsRealNonSymmetricMatrix(), EigsRealNonSymmetricMatrixShift(), EigsRealSymmetricFunc(), EigsRealSymmetricMatrix(), and EigsRealSymmetricMatrixShift().

Member Data Documentation

◆ current_distribution

int octave::rand::current_distribution

private

Definition at line 200 of file oct-rand.h.

Referenced by do_distribution(), do_reset(), do_scalar(), do_state(), fill(), initialize_mersenne_twister(), initialize_ranlib_generators(), save_state(), and switch_to_generator().

◆ instance

rand * octave::rand::instance = nullptr

staticprivate

Definition at line 185 of file oct-rand.h.

Referenced by instance_ok().

◆ rand_states

std::map<int, uint32NDArray> octave::rand::rand_states

private

Definition at line 207 of file oct-rand.h.

Referenced by do_reset(), do_state(), initialize_mersenne_twister(), save_state(), and switch_to_generator().

◆ use_old_generators

bool octave::rand::use_old_generators

private

Definition at line 204 of file oct-rand.h.

Referenced by do_reset(), do_scalar(), do_seed(), do_state(), exponential(), fill(), gamma(), normal(), poisson(), and uniform().

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

liboctave/numeric/oct-rand.h
liboctave/numeric/oct-rand.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ rand()

◆ ~rand()

Member Function Documentation

◆ cleanup_instance()

◆ distribution() [1/2]

◆ distribution() [2/2]

◆ do_distribution() [1/2]

◆ do_distribution() [2/2]

◆ do_exponential_distribution()

◆ do_float_nd_array()

◆ do_gamma_distribution()

◆ do_nd_array()

◆ do_normal_distribution()

◆ do_poisson_distribution()

◆ do_reset() [1/2]

◆ do_reset() [2/2]

◆ do_scalar()

◆ do_seed() [1/2]

◆ do_seed() [2/2]

◆ do_state() [1/2]

◆ do_state() [2/2]

◆ do_uniform_distribution()

◆ do_vector()

◆ exponential() [1/3]

◆ exponential() [2/3]

◆ exponential() [3/3]

◆ exponential_distribution()

◆ fill() [1/2]

◆ fill() [2/2]

◆ float_nd_array()

◆ float_scalar()

◆ float_vector()

◆ gamma() [1/3]

◆ gamma() [2/3]

◆ gamma() [3/3]

◆ gamma_distribution()

◆ get_dist_id()

◆ get_internal_state()

◆ initialize_mersenne_twister()

◆ initialize_ranlib_generators()

◆ instance_ok()

◆ nd_array()

◆ normal() [1/3]

◆ normal() [2/3]

◆ normal() [3/3]

◆ normal_distribution()

◆ poisson() [1/3]

◆ poisson() [2/3]

◆ poisson() [3/3]

◆ poisson_distribution()

◆ reset() [1/2]

◆ reset() [2/2]

◆ save_state()

◆ scalar()

◆ seed() [1/2]

◆ seed() [2/2]

◆ set_internal_state()

◆ state() [1/2]

◆ state() [2/2]

◆ switch_to_generator()

◆ uniform() [1/3]

◆ uniform() [2/3]

◆ uniform() [3/3]

◆ uniform_distribution()

◆ vector()

Member Data Documentation

◆ current_distribution

◆ instance