Struct PowerOfTwo

pub struct PowerOfTwo { /* private fields */ }

A type representing 2^k usize.

Zero is not 2^k though you can create PowerOfTwo by zero. In that case, zero is considered as usize::MAX + 1 which is another 2^k.

Implementations

impl PowerOfTwo

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

Creates a new PowerOfTwo from the given value.

pub const fn get(&self) -> usize

Returns inner value.

pub const fn quotient(&self, numerator: usize) -> usize

Returns numerator / self.

Examples

use my_ecs::prelude::PowerOfTwo;

let v = PowerOfTwo::new(4).unwrap();
assert_eq!(v.quotient(3), 0);
assert_eq!(v.quotient(4), 1);
assert_eq!(v.quotient(5), 1);

pub const fn remainder(&self, numerator: usize) -> usize

Returns numerator % self.

Examples

use my_ecs::prelude::PowerOfTwo;

let v = PowerOfTwo::new(4).unwrap();
assert_eq!(v.remainder(3), 3);
assert_eq!(v.remainder(4), 0);
assert_eq!(v.remainder(5), 1);

Trait Implementations

impl Clone for PowerOfTwo

fn clone(&self) -> PowerOfTwo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PowerOfTwo

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

Formats the value using the given formatter.

impl Hash for PowerOfTwo

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 Ord for PowerOfTwo

fn cmp(&self, other: &Self) -> 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 PartialEq for PowerOfTwo

fn eq(&self, other: &Self) -> 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 PartialOrd for PowerOfTwo

fn partial_cmp(&self, other: &Self) -> 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 Copy for PowerOfTwo

impl Eq for PowerOfTwo