Skip to main content

FieldElement

Struct FieldElement 

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

A field element in GF(2^283) represented by 5 u64 limbs (320 bits).

Implementations§

Source§

impl FieldElement

Source

pub fn zero() -> Self

The additive identity element (zero).

Source

pub fn one() -> Self

The multiplicative identity element (one).

Source

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

Create a field element from its canonical byte representation.

The bytes are interpreted as a big-endian representation of the field element.

Source

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

Convert this field element to its canonical byte representation.

The bytes are a big-endian representation of the field element.

Source

pub fn is_zero(&self) -> bool

Check if this field element is zero.

Source

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

Add two field elements in GF(2^283).

In binary fields, addition is performed using XOR.

Source

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

Multiply two field elements in GF(2^283).

Uses the irreducible polynomial for reduction.

Source

pub fn square(&self) -> Self

Square a field element in GF(2^283).

Source

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

Compute the multiplicative inverse of a field element.

Uses Fermat’s Little Theorem: a^(2^m - 2) = a^(-1) in GF(2^m). Returns an error if the element is zero.

Source

pub fn sqrt(&self) -> Self

Compute the square root of a field element.

In binary fields of characteristic 2, sqrt(x) = x^(2^(m-1)).

Source

pub fn trace(&self) -> u64

Get the trace of the element.

The trace is Tr(z) = z + z^2 + z^4 + … + z^(2^(m-1)). For compressed points, it’s used to disambiguate the y-coordinate.

Trait Implementations§

Source§

impl Clone for FieldElement

Source§

fn clone(&self) -> FieldElement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConditionallySelectable for FieldElement

Source§

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice. Read more
Source§

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice. Read more
Source§

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves. Read more
Source§

impl Copy for FieldElement

Source§

impl Debug for FieldElement

Source§

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

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

impl Eq for FieldElement

Source§

impl PartialEq for FieldElement

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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