Struct rant::RantSelector

source · [−]

pub struct RantSelector { /* private fields */ }

Expand description

Represents a Rant selector instance used by the resolver to select block branches.

Implementations

source

impl RantSelector

source

pub fn new(mode: SelectorMode) -> Self

Creates a new selector.

source

pub fn into_handle(self) -> RantSelectorHandle

Converts the instance into a handle.

source

pub fn mode(&self) -> SelectorMode

The mode assigned to the selector.

source

pub fn index(&self) -> usize

The next index to be selected.

source

pub fn count(&self) -> usize

The number of block elements that this selector is initialized for.

A value of 0 indicates that the selector is uninitialized (as selecting over 0 branches is impossible).

source

pub fn parity(&self) -> bool

Indicates the parity state of the selector. Some selectors use two alternating passes (such as mirror modes). The parity indicates which of these passes is currently active.

source

pub fn is_frozen(&self) -> bool

Indicates whether the selector is frozen.

source

pub fn set_frozen(&mut self, frozen: bool)

Sets the frozen state of the selector.

source

pub fn is_initialized(&self) -> bool

Indicates whether the selector has been initialized with [Selector::init].

source

pub fn init(
 &mut self,
 rng: &RantRng,
 elem_count: usize
) -> Result<(), SelectorError>

Initializes the selector state using the specified element count.

source

pub fn select(
 &mut self,
 elem_count: usize,
 rng: &RantRng
) -> Result<usize, SelectorError>

Returns the next branch index and advances the selector state.

Trait Implementations

source

impl Clone for RantSelector

source

fn clone(&self) -> RantSelector

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for RantSelector

source

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

Formats the value using the given formatter. Read more

source

impl From<RantSelector> for RantSelectorHandle

source

fn from(sel: RantSelector) -> Self

Converts to this type from the input type.

source

impl IntoRant for RantSelector

source

fn into_rant(self) -> RantValue

Converts to a RantValue.

source

impl TryIntoRant for RantSelector

source

fn try_into_rant(self) -> Result<RantValue, ValueError>

Attempts to convert to a RantValue.

Auto Trait Implementations

impl RefUnwindSafe for RantSelector

impl Send for RantSelector

impl Sync for RantSelector

impl Unpin for RantSelector

impl UnwindSafe for RantSelector

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct rant::RantSelector

Implementations

impl RantSelector

pub fn new(mode: SelectorMode) -> Self

pub fn into_handle(self) -> RantSelectorHandle

pub fn mode(&self) -> SelectorMode

pub fn index(&self) -> usize

pub fn count(&self) -> usize

pub fn parity(&self) -> bool

pub fn is_frozen(&self) -> bool

pub fn set_frozen(&mut self, frozen: bool)

pub fn is_initialized(&self) -> bool

pub fn init( &mut self, rng: &RantRng, elem_count: usize) -> Result<(), SelectorError>

pub fn select( &mut self, elem_count: usize, rng: &RantRng) -> Result<usize, SelectorError>

Trait Implementations

impl Clone for RantSelector

fn clone(&self) -> RantSelector

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

impl Debug for RantSelector

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

impl From<RantSelector> for RantSelectorHandle

fn from(sel: RantSelector) -> Self

impl IntoRant for RantSelector

fn into_rant(self) -> RantValue

impl TryIntoRant for RantSelector

fn try_into_rant(self) -> Result<RantValue, ValueError>

Auto Trait Implementations

impl RefUnwindSafe for RantSelector

impl Send for RantSelector

impl Sync for RantSelector

impl Unpin for RantSelector

impl UnwindSafe for RantSelector

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn init(
&mut self,
rng: &RantRng,
elem_count: usize
) -> Result<(), SelectorError>

pub fn select(
&mut self,
elem_count: usize,
rng: &RantRng
) -> Result<usize, SelectorError>

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,