Struct poisson::Builder

pub struct Builder<F, V> where
    F: Float,
    V: Vector<F>,  { /* fields omitted */ }

Builder for the generator.

Methods

impl<V, F> Builder<F, V> where
    F: Float,
    V: Vector<F>, 

pub fn with_radius(radius: F, poisson_type: Type) -> Self

New Builder with type of distribution and radius specified. The radius should be ]0, √2 / 2]

pub fn with_relative_radius(relative: F, poisson_type: Type) -> Self

New Builder with type of distribution and relative radius specified. The relative radius should be ]0, 1]

pub fn with_samples(samples: usize, relative: F, poisson_type: Type) -> Self

New Builder with type of distribution, approximate amount of samples and relative radius specified. The amount of samples should be larger than 0. The relative radius should be [0, 1]. For non-perioditic this is supported only for 2, 3 and 4 dimensional generation. For perioditic this is supported up to 8 dimensions.

pub fn radius(&self) -> F

Returns the radius of the generator.

pub fn poisson_type(&self) -> Type

Returns the type of the generator.

pub fn build<R, A>(self, rng: R, _algo: A) -> Generator<F, V, R, A> where
    R: Rng,
    A: Creator<F, V>, 

Builds generator with random number generator and algorithm specified.

Trait Implementations

impl<F: Default, V: Default> Default for Builder<F, V> where
    F: Float,
    V: Vector<F>, 

fn default() -> Builder<F, V>

Returns the "default value" for a type.

impl<F: Clone, V: Clone> Clone for Builder<F, V> where
    F: Float,
    V: Vector<F>, 

fn clone(&self) -> Builder<F, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PartialEq, V: PartialEq> PartialEq<Builder<F, V>> for Builder<F, V> where
    F: Float,
    V: Vector<F>, 

fn eq(&self, other: &Builder<F, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder<F, V>) -> bool

This method tests for !=.

impl<F: Debug, V: Debug> Debug for Builder<F, V> where
    F: Float,
    V: Vector<F>, 

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

Formats the value using the given formatter.