octave_rand Class Reference

#include "oct-rand.h"

Collaboration diagram for octave_rand:

Public Member Functions
	~octave_rand (void)=default

Static Public Member Functions
static std::string	distribution (void)
static void	distribution (const std::string &d)
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 (void)
static void	reset (const std::string &d)
static double	scalar (double a=1.0)
static double	seed (void)
static void	seed (double s)
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
	octave_rand (void)

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

Private Member Functions
std::string	do_distribution (void)
void	do_distribution (const std::string &d)
void	do_exponential_distribution (void)
FloatNDArray	do_float_nd_array (const dim_vector &dims, float a=1.)
float	do_float_scalar (float a=1.)
Array< float >	do_float_vector (octave_idx_type n, 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)
double	do_scalar (double a=1.)
double	do_seed (void)
void	do_seed (double s)
uint32NDArray	do_state (const std::string &d)
void	do_state (const uint32NDArray &s, const std::string &d)
void	do_uniform_distribution (void)
Array< double >	do_vector (octave_idx_type n, double a=1.)
void	fill (octave_idx_type len, double *v, double a)
void	fill (octave_idx_type len, float *v, float a)
int	get_dist_id (const std::string &d)
uint32NDArray	get_internal_state (void)
void	initialize_mersenne_twister (void)
void	initialize_ranlib_generators (void)
void	save_state (void)
void	set_internal_state (const uint32NDArray &s)
void	switch_to_generator (int dist)

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 octave_rand *	instance = nullptr

Detailed Description

Definition at line 39 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 186 of file oct-rand.h.

Constructor & Destructor Documentation

octave_rand()

octave_rand::octave_rand ( void  )

protected

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

References initialize_mersenne_twister(), and initialize_ranlib_generators().

Referenced by instance_ok().

~octave_rand()

octave_rand::~octave_rand ( void  )

default

Member Function Documentation

cleanup_instance()

static void octave_rand::cleanup_instance ( void  )

inlinestaticprivate

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

Referenced by instance_ok().

distribution() [1/2]

static std::string octave_rand::distribution ( void  )

inlinestatic

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

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

distribution() [2/2]

static void octave_rand::distribution ( const std::string &  d )

inlinestatic

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

References d.

do_distribution() [1/2]

std::string octave_rand::do_distribution ( void  )

private

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

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

do_distribution() [2/2]

void octave_rand::do_distribution ( const std::string &  d )

private

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

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

do_exponential_distribution()

void octave_rand::do_exponential_distribution ( void  )

private

Definition at line 285 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 521 of file oct-rand.cc.

References a, dims, fill(), octave_value::numel(), and retval.

do_float_scalar()

float octave_rand::do_float_scalar ( float  a = 1. )

private

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

References a, current_distribution, expon_dist, f, F77_FUNC(), fgenexp(), fgengam(), fgennor(), fgenunf(), fignpoi(), gamma_dist, octave::math::isfinite(), NaN(), normal_dist, oct_float_rande(), oct_float_randg(), oct_float_randn(), oct_float_randu(), oct_randp(), poisson_dist, retval, save_state(), uniform_dist, and use_old_generators.

do_float_vector()

Array< float > octave_rand::do_float_vector ( octave_idx_type  n, float  a = 1.  )

private

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

References a, fill(), octave_value::numel(), and retval.

do_gamma_distribution()

void octave_rand::do_gamma_distribution ( void  )

private

Definition at line 301 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 506 of file oct-rand.cc.

References a, dims, fill(), octave_value::numel(), and retval.

do_normal_distribution()

void octave_rand::do_normal_distribution ( void  )

private

Definition at line 277 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 293 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 143 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 178 of file oct-rand.cc.

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

do_scalar()

double octave_rand::do_scalar ( double  a = 1. )

private

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

References a, current_distribution, dgenexp(), dgengam(), dgennor(), dgenunf(), dignpoi(), expon_dist, F77_FUNC(), gamma_dist, octave::math::isfinite(), NaN(), normal_dist, oct_rande(), oct_randg(), oct_randn(), oct_randp(), oct_randu(), poisson_dist, retval, save_state(), uniform_dist, and use_old_generators.

do_seed() [1/2]

double octave_rand::do_seed ( void  )

private

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

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

do_seed() [2/2]

void octave_rand::do_seed ( double  s )

private

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

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

do_state() [1/2]

uint32NDArray octave_rand::do_state ( const std::string &  d )

private

Definition at line 150 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 156 of file oct-rand.cc.

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

do_uniform_distribution()

void octave_rand::do_uniform_distribution ( void  )

private

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

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

do_vector()

Array< double > octave_rand::do_vector ( octave_idx_type  n, double  a = 1.  )

private

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

References a, fill(), octave_value::numel(), and retval.

exponential_distribution()

static void octave_rand::exponential_distribution ( void  )

inlinestatic

Definition at line 121 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 654 of file oct-rand.cc.

References a, current_distribution, dgenexp(), dgengam(), dgennor(), dgenunf(), dignpoi(), expon_dist, F77_FUNC(), gamma_dist, octave::math::isfinite(), NaN(), normal_dist, oct_fill_rande(), oct_fill_randg(), oct_fill_randn(), oct_fill_randp(), oct_fill_randu(), poisson_dist, save_state(), tmp, uniform_dist, use_old_generators, and x.

Referenced by do_float_nd_array(), do_float_vector(), 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 723 of file oct-rand.cc.

References a, current_distribution, expon_dist, f, F77_FUNC(), fgenexp(), fgengam(), fgennor(), fgenunf(), fignpoi(), gamma_dist, octave::math::isfinite(), NaN(), normal_dist, oct_fill_float_rande(), oct_fill_float_randg(), oct_fill_float_randn(), oct_fill_float_randp(), oct_fill_float_randu(), poisson_dist, save_state(), tmp, 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 174 of file oct-rand.h.

References a, and dims.

Referenced by do_rand().

float_scalar()

static float octave_rand::float_scalar ( float  a = 1.0 )

inlinestatic

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

References a, and 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 160 of file oct-rand.h.

References a.

gamma_distribution()

static void octave_rand::gamma_distribution ( void  )

inlinestatic

Definition at line 133 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 608 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 592 of file oct-rand.cc.

References MT_N, oct_get_state(), and s.

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 562 of file oct-rand.cc.

References current_distribution, expon_dist, gamma_dist, get_internal_state(), normal_dist, oct_init_by_entropy(), poisson_dist, rand_states, s, set_internal_state(), and uniform_dist.

Referenced by octave_rand().

initialize_ranlib_generators()

void octave_rand::initialize_ranlib_generators ( void  )

private

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

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

Referenced by do_reset(), and octave_rand().

instance_ok()

bool octave_rand::instance_ok ( void  )

static

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

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

nd_array()

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

inlinestatic

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

References a, and dims.

Referenced by do_rand().

normal_distribution()

static void octave_rand::normal_distribution ( void  )

inlinestatic

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

Referenced by do_distribution(), and do_rand().

poisson_distribution()

static void octave_rand::poisson_distribution ( void  )

inlinestatic

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

Referenced by do_distribution(), and do_rand().

reset() [1/2]

static void octave_rand::reset ( void  )

inlinestatic

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

Referenced by do_rand().

reset() [2/2]

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

inlinestatic

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

References d.

save_state()

void octave_rand::save_state ( void  )

private

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

References current_distribution, get_internal_state(), and rand_states.

Referenced by do_float_scalar(), do_scalar(), and fill().

scalar()

static double octave_rand::scalar ( double  a = 1.0 )

inlinestatic

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

References a, and NaN().

Referenced by do_rand().

seed() [1/2]

static double octave_rand::seed ( void  )

inlinestatic

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

References NaN().

Referenced by do_rand().

seed() [2/2]

static void octave_rand::seed ( double  s )

inlinestatic

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

References s.

set_internal_state()

void octave_rand::set_internal_state ( const uint32NDArray &  s )

private

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

References MT_N, oct_init_by_array(), oct_set_state(), and s.

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 75 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 81 of file oct-rand.h.

References d, and s.

switch_to_generator()

void octave_rand::switch_to_generator ( int  dist )

private

Definition at line 643 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_distribution()

static void octave_rand::uniform_distribution ( void  )

inlinestatic

Definition at line 109 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 154 of file oct-rand.h.

References a.

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 197 of file oct-rand.h.

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

instance

octave_rand * octave_rand::instance = nullptr

staticprivate

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

Referenced by instance_ok().

rand_states

std::map<int, uint32NDArray> octave_rand::rand_states

private

Definition at line 204 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 201 of file oct-rand.h.

Referenced by do_float_scalar(), do_reset(), do_scalar(), do_seed(), do_state(), and fill().

---

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

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