Struct fixed32::Fp

pub struct Fp(pub i32);

A fixed-point number with 16.16 format.

Tuple Fields

0: i32

Implementations

impl Fp

pub const SHIFT: i32 = 16i32

The scaling factor used for fixed-point arithmetic.

pub const SCALE: i32 = 65_536i32

pub const SCALE_I64: i64 = 65_536i64

pub const FSCALE: f32 = 65536f32

pub const FRAC_PI_2: Fp = _

pub const PI: Fp = _

pub const TAU: Fp = _

pub fn one() -> Self

Returns the constant Fp value for one.

Examples

use fixed32::Fp;
assert_eq!(1, Fp::one().into());

pub fn is_zero(self) -> bool

Checks if the Fp value is zero.

Examples

use fixed32::Fp;
assert!(Fp::zero().is_zero());

pub fn neg_one() -> Self

Returns the constant Fp value for negative one.

Examples

use fixed32::Fp;
assert_eq!(<Fp as Into<i16>>::into(Fp::neg_one()), -1);

pub fn zero() -> Self

Returns the constant Fp value for zero.

Examples

use fixed32::Fp;
assert_eq!(<Fp as Into<i16>>::into(Fp::zero()), 0);

pub fn normalize(self) -> Self

pub fn ceil(self) -> Self

pub fn round(self) -> Self

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

pub fn sin(self) -> Self

pub fn asin(self) -> Self

pub fn cos(self) -> Self

pub fn acos(self) -> Self

pub fn abs(self) -> Self

pub fn sqrt(self) -> Self

pub const MIN: Fp = _

pub const MAX: Fp = _

Trait Implementations

impl Add for Fp

type Output = Fp

The resulting type after applying the + operator.

fn add(self, rhs: Fp) -> Self

Performs the + operation.

impl AddAssign for Fp

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Fp

fn clone(&self) -> Fp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fp

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

Formats the value using the given formatter.

impl Default for Fp

fn default() -> Fp

Returns the “default value” for a type.

impl Display for Fp

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

Formats the value using the given formatter.

impl Div<Fp> for i16

type Output = Fp

The resulting type after applying the / operator.

fn div(self, rhs: Fp) -> Self::Output

Performs the / operation.

impl Div for Fp

type Output = Fp

The resulting type after applying the / operator.

fn div(self, rhs: Fp) -> Self

Performs the / operation.

impl From<Fp> for f32

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<Fp> for i16

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<Fp> for i32

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<Fp> for u16

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<Fp> for u32

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<Fp> for usize

fn from(fp: Fp) -> Self

Converts to this type from the input type.

impl From<f32> for Fp

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<i16> for Fp

fn from(v: i16) -> Self

Converts to this type from the input type.

impl Hash for Fp

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 Mul<Fp> for i16

type Output = Fp

The resulting type after applying the * operator.

fn mul(self, rhs: Fp) -> Self::Output

Performs the * operation.

impl Mul<i16> for Fp

type Output = Fp

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> Self

Performs the * operation.

impl Mul for Fp

type Output = Fp

The resulting type after applying the * operator.

fn mul(self, rhs: Fp) -> Self

Performs the * operation.

impl Neg for Fp

type Output = Fp

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Fp

fn cmp(&self, other: &Fp) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Fp

fn eq(&self, other: &Fp) -> 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 Fp

fn partial_cmp(&self, other: &Fp) -> 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 Rem for Fp

type Output = Fp

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl Sub for Fp

type Output = Fp

The resulting type after applying the - operator.

fn sub(self, rhs: Fp) -> Self

Performs the - operation.

impl SubAssign for Fp

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Fp

impl Eq for Fp

impl StructuralPartialEq for Fp