Struct NonZeroPow2

pub struct NonZeroPow2<N: NonZeroable>(/* private fields */);

A number that is non-zero and is a power of two.

Implementations

impl<N: NonZeroable> NonZeroPow2<N>

pub fn of<T: LanesMult>() -> Self

where N: LanesMultNum,

Gets the multiplier for the given SIMD type.

impl<N> NonZeroPow2<N>

where N: Number + Shl<u32, Output = N> + NonZeroable,

pub fn v2() -> Self

The value 2.

Examples

assert_eq!(NonZeroPow2::<u32>::v2().get(), 2);

pub fn v4() -> Self

The value 4.

Examples

assert_eq!(NonZeroPow2::<u32>::v4().get(), 4);

pub fn v8() -> Self

The value 8.

Examples

assert_eq!(NonZeroPow2::<u32>::v8().get(), 8);

pub fn v16() -> Self

The value 16.

Examples

assert_eq!(NonZeroPow2::<u32>::v16().get(), 16);

pub fn v32() -> Self

The value 32.

Examples

assert_eq!(NonZeroPow2::<u32>::v32().get(), 32);

pub fn v64() -> Self

The value 64.

Examples

assert_eq!(NonZeroPow2::<u32>::v64().get(), 64);

pub fn v128() -> Self

The value 128.

Examples

assert_eq!(NonZeroPow2::<u32>::v128().get(), 128);

impl<N: NonZeroable> NonZeroPow2<N>

pub unsafe fn new_unchecked(value: N) -> Self

Creates a new NonZeroPow2.

Safety

Ensure the value is not zero and is a power of two.

pub const unsafe fn from_nonzero_unchecked(value: N::NonZeroType) -> Self

Creates a new NonZeroPow2.

Safety

Ensure the value is a power of two.

pub fn new(value: N) -> Option<Self>

Creates a new NonZeroPow2.

Returns None if the given value is zero or not a power of two.

Examples

assert!(NonZeroPow2::new(0usize).is_none());
assert!(NonZeroPow2::new(2usize).is_some());
assert!(NonZeroPow2::new(4usize).is_some());
assert!(NonZeroPow2::new(6usize).is_none());

pub fn get(self) -> N

Gets the value of the number in its primitive representation.

Examples

assert_eq!(
    NonZeroPow2::new(32usize).unwrap().get(),
    32usize,
);

pub fn get_nonzero(self) -> N::NonZeroType

Gets the value of the number in its nonzero representation.

Examples

assert_eq!(
    NonZeroPow2::new(32usize).unwrap().get_nonzero(),
    NonZeroUsize::new(32usize).unwrap(),
);

Trait Implementations

impl<N: Clone + NonZeroable> Clone for NonZeroPow2<N>

where N::NonZeroType: Clone,

fn clone(&self) -> NonZeroPow2<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + NonZeroable> Debug for NonZeroPow2<N>

where N::NonZeroType: Debug,

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

Formats the value using the given formatter.

impl<N: Hash + NonZeroable> Hash for NonZeroPow2<N>

where N::NonZeroType: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: NonZeroable> Multiplier for NonZeroPow2<N>

type Number = N

The type of the multiplied number of this multiplier.

impl<N: Ord + NonZeroable> Ord for NonZeroPow2<N>

where N::NonZeroType: Ord,

fn cmp(&self, other: &NonZeroPow2<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<N: PartialEq + NonZeroable> PartialEq for NonZeroPow2<N>

where N::NonZeroType: PartialEq,

fn eq(&self, other: &NonZeroPow2<N>) -> bool

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

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<N: PartialOrd + NonZeroable> PartialOrd for NonZeroPow2<N>

where N::NonZeroType: PartialOrd,

fn partial_cmp(&self, other: &NonZeroPow2<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<N: Copy + NonZeroable> Copy for NonZeroPow2<N>

where N::NonZeroType: Copy,

impl<N: Eq + NonZeroable> Eq for NonZeroPow2<N>

where N::NonZeroType: Eq,

impl<N: NonZeroable + Number> Multiplier for NonZeroPow2<N>

where Self: Copy,

impl<N: NonZeroable> StructuralPartialEq for NonZeroPow2<N>