Builder

Struct Builder

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

Expand description

Builder for the generator.

Implementations§

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, V> Clone for Builder<F, V>
where F: Float + Clone, V: Vector<F> + Clone,

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Returns the “default value” for a type. Read more

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

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

Auto Trait Implementations§

impl<F, V> Freeze for Builder<F, V>
where F: Freeze,

impl<F, V> RefUnwindSafe for Builder<F, V>
where F: RefUnwindSafe, V: RefUnwindSafe,

impl<F, V> Send for Builder<F, V>
where F: Send, V: Send,

impl<F, V> Sync for Builder<F, V>
where F: Sync, V: Sync,

impl<F, V> Unpin for Builder<F, V>
where F: Unpin, V: Unpin,

impl<F, V> UnwindSafe for Builder<F, V>
where F: UnwindSafe, V: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.