Struct FieldElement

Source
pub struct FieldElement(/* private fields */);
Expand description

P-192 field element representing values in š”½ā‚š, where p = 2¹⁹² āˆ’ 2⁶⁓ āˆ’ 1. Internally stored as 6 little‐endian 32‐bit limbs.

Implementations§

Source§

impl FieldElement

Source

pub fn from_u32(n: u32) -> Self

Build a field element from a small literal (0 ≤ n < 2³²)

Source

pub fn zero() -> Self

The additive identity: 0

Source

pub fn one() -> Self

The multiplicative identity: 1

Source

pub fn from_bytes(bytes: &[u8; 24]) -> Result<Self>

Create a field element from big‐endian bytes. Validates that the value < p. Returns Err if ≄ p.

Source

pub fn to_bytes(&self) -> [u8; 24]

Convert this field element into big‐endian bytes.

Source

pub fn is_valid(&self) -> bool

Constant‐time check: is self < p ?

Source

pub fn is_zero(&self) -> bool

Check if element is zero

Source

pub fn is_odd(&self) -> bool

Return true if the element is odd (least‐significant bit = 1).

Source

pub fn add(&self, other: &Self) -> Self

Constant‐time addition: (self + other) mod p

Source

pub fn sub(&self, other: &Self) -> Self

Constant‐time subtraction: (self - other) mod p

Source

pub fn mul(&self, other: &Self) -> Self

Field multiplication: (self * other) mod p Implements schoolbook 6Ɨ6 → 12‐limb product, then reduction

Source

pub fn square(&self) -> Self

Field squaring: (self²) mod p

Source

pub fn invert(&self) -> Result<Self>

Compute multiplicative inverse via Fermat: a^(p-2) mod p

Source

pub fn negate(&self) -> Self

Negate this field element: returns p - self if non-zero, else zero

Source

pub fn sqrt(&self) -> Option<Self>

Compute square root using the fact that p ≔ 3 (mod 4) For such primes, sqrt(x) = x^((p+1)/4)

Trait Implementations§

Source§

impl Clone for FieldElement

Source§

fn clone(&self) -> FieldElement

Returns a duplicate 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 FieldElement

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FieldElement

Source§

fn eq(&self, other: &FieldElement) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for FieldElement

Source§

impl StructuralPartialEq for FieldElement

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

šŸ”¬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V