Struct Fp

pub struct Fp(/* private fields */);

A fixed-point number with 16.16 format.

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 const MIN: Fp

pub const MAX: Fp

pub const fn from_raw(raw: i32) -> Fp

Creates a new Fp instance from a raw integer value.

Warning: This constructor should be used with caution. It directly creates an Fp instance from a raw integer without any validation or scaling logic. It is almost always preferable to use higher-level constructors or conversion traits like From<T> to ensure that the fixed-point values are correctly initialized.

Example

use fixed32::Fp;
let fp = Fp::from_raw(100);

pub const fn one() -> Fp

Returns the constant Fp value for one.

Examples

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

pub const fn neg_one() -> Fp

Returns the constant Fp value for negative one.

Examples

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

pub const fn zero() -> Fp

Returns the constant Fp value for zero.

Examples

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

pub const fn is_zero(self) -> bool

Checks if the Fp value is zero.

Examples

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

pub const fn normalize(self) -> Fp

pub const fn floor(self) -> Fp

pub const fn ceil(self) -> Fp

pub const fn round(self) -> Fp

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

pub fn sin(self) -> Fp

pub fn asin(self) -> Fp

pub fn cos(self) -> Fp

pub fn acos(self) -> Fp

pub const fn abs(self) -> Fp

pub const fn signum(self) -> Fp

pub fn sqrt(self) -> Fp

pub const fn inner(self) -> i32

Returns the raw integer value from the Fp.

This method retrieves the underlying raw scaled value stored in the Fp instance. The returned value is the raw integer that represents the scaled fixed-point number.

Warning: Directly using the raw value returned by this method should be avoided unless absolutely necessary. It is generally preferable to use higher-level methods or conversion traits like From<T> and into() for conversions, which handle scaling and ensure correctness. Using inner() may expose the raw value in a way that bypasses intended abstractions and checks, potentially leading to incorrect usage.

Example

use fixed32::Fp;
let fp = Fp::from_raw(100);
let raw_value = fp.inner();

// Preferred conversion using From<T> trait
let value_from_fp: i32 = fp.into();

Trait Implementations

impl Add for Fp

type Output = Fp

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Fp

fn add_assign(&mut self, other: Fp)

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<(), Error>

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<(), Error>

Formats the value using the given formatter.

impl Div for Fp

type Output = Fp

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<f32> for Fp

fn from(v: f32) -> Fp

Converts to this type from the input type.

impl From<i16> for Fp

fn from(v: i16) -> Fp

Converts to this type from the input type.

impl Hash for Fp

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

where __H: Hasher,

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

type Output = Fp

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Fp

type Output = Fp

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Fp

type Output = Fp

The resulting type after applying the - operator.

fn neg(self) -> Fp

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,

Restrict a value to a certain interval.

impl PartialEq<i16> for Fp

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

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

Performs the % operation.

impl Sub for Fp

type Output = Fp

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Fp

fn sub_assign(&mut self, other: Fp)

Performs the -= operation.

impl TryFrom<i32> for Fp

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(v: i32) -> Result<Fp, <Fp as TryFrom<i32>>::Error>

Performs the conversion.

impl Copy for Fp

impl Eq for Fp

impl StructuralPartialEq for Fp