Struct rgsl::types::qrng::QRng

pub struct QRng { /* private fields */ }

Implementations

impl QRng

pub fn new(t: QRngType, d: u32) -> Option<Self>

This function returns a pointer to a newly-created instance of a quasi-random sequence generator of type T and dimension d. If there is insufficient memory to create the generator then the function returns a null pointer and the error handler is invoked with an error code of Value::NoMemory.

pub fn init(&mut self)

This function reinitializes the generator self to its starting point. Note that quasi-random sequences do not use a seed and always produce the same set of values.

pub fn get(&self, x: &mut [f64]) -> Value

This function stores the next point from the sequence generator self in the array x. The space available for x must match the dimension of the generator. The point x will lie in the range 0 < x_i < 1 for each x_i.

pub fn name(&self) -> Option<String>

This function returns a pointer to the name of the generator.

pub fn size(&self) -> usize

These functions return a pointer to the state of generator r and its size.

pub fn state(&mut self) -> Option<&[i8]>

This function returns a pointer to the state of generator self.

pub fn state_mut(&mut self) -> Option<&mut [i8]>

This function returns a pointer to the state of generator self.

pub fn copy(&self, dest: &mut QRng) -> Value

This function copies the quasi-random sequence generator src into the pre-existing generator dest, making dest into an exact copy of self. The two generators must be of the same type.

Trait Implementations

impl Clone for QRng

fn clone(&self) -> Self

This function returns a pointer to a newly created generator which is an exact copy of the generator self.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for QRng

fn drop(&mut self)

Executes the destructor for this type.