Struct opencv::core::RNG

pub struct RNG { /* private fields */ }

Random Number Generator

Random number generator. It encapsulates the state (currently, a 64-bit integer) and has methods to return scalar random values and to fill arrays with random values. Currently it supports uniform and Gaussian (normal) distributions. The generator uses Multiply-With-Carry algorithm, introduced by G. Marsaglia ( http://en.wikipedia.org/wiki/Multiply-with-carry ). Gaussian-distribution random numbers are generated using the Ziggurat algorithm ( http://en.wikipedia.org/wiki/Ziggurat_algorithm ), introduced by G. Marsaglia and W. W. Tsang.

Implementations

impl RNG

pub fn default() -> Result<RNG>

constructor

These are the RNG constructors. The first form sets the state to some pre-defined value, equal to 2**32-1 in the current implementation. The second form sets the state to the specified value. If you passed state=0 , the constructor uses the above default value instead to avoid the singular random number sequence, consisting of all zeros.

pub fn new(state: u64) -> Result<RNG>

constructor

These are the RNG constructors. The first form sets the state to some pre-defined value, equal to 2**32-1 in the current implementation. The second form sets the state to the specified value. If you passed state=0 , the constructor uses the above default value instead to avoid the singular random number sequence, consisting of all zeros.

Overloaded parameters

Parameters

• state: 64-bit value used to initialize the RNG.

Trait Implementations

impl Boxed for RNG

unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> *mut c_void

Return the underlying mutable raw pointer

impl Debug for RNG

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RNG

fn drop(&mut self)

Executes the destructor for this type.

impl RNGTrait for RNG

fn as_raw_mut_RNG(&mut self) -> *mut c_void

fn set_state(&mut self, val: u64)

fn next(&mut self) -> Result<u32>

The method updates the state using the MWC algorithm and returns the next 32-bit random number.

fn to_u8(&mut self) -> Result<u8>

Each of the methods updates the state using the MWC algorithm and returns the next random number of the specified type. In case of integer types, the returned number is from the available value range for the specified type. In case of floating-point types, the returned value is from [0,1) range.

fn to_i8(&mut self) -> Result<i8>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_u16(&mut self) -> Result<u16>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_i16(&mut self) -> Result<i16>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_u32(&mut self) -> Result<u32>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_i32(&mut self) -> Result<i32>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_f32(&mut self) -> Result<f32>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_f64(&mut self) -> Result<f64>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn apply(&mut self) -> Result<u32>

returns a random integer sampled uniformly from [0, N).

fn apply_range(&mut self, n: u32) -> Result<u32>

returns a random integer sampled uniformly from [0, N).

fn uniform(&mut self, a: i32, b: i32) -> Result<i32>

returns uniformly distributed integer random number from [a,b) range

fn uniform_f32(&mut self, a: f32, b: f32) -> Result<f32>

returns uniformly distributed integer random number from [a,b) range

fn uniform_f64(&mut self, a: f64, b: f64) -> Result<f64>

returns uniformly distributed integer random number from [a,b) range

fn fill( &mut self, mat: &mut impl ToInputOutputArray, dist_type: i32, a: &impl ToInputArray, b: &impl ToInputArray, saturate_range: bool ) -> Result<()>

Fills arrays with random numbers.

fn fill_def( &mut self, mat: &mut impl ToInputOutputArray, dist_type: i32, a: &impl ToInputArray, b: &impl ToInputArray ) -> Result<()>

Fills arrays with random numbers.

fn gaussian(&mut self, sigma: f64) -> Result<f64>

Returns the next random number sampled from the Gaussian distribution

impl RNGTraitConst for RNG

fn as_raw_RNG(&self) -> *const c_void

fn state(&self) -> u64

fn equals(&self, other: &RNG) -> Result<bool>

impl Send for RNG