Struct F2Element 

pub struct F2Element { /* private fields */ }

Element of the finite field $\mathbb{F}_2$

Implementations

impl F2Element

pub const ZERO: Self

The constant zero

pub const ONE: Self

The constant one

pub fn from_u64(x: u64) -> Self

Create a new element of $\mathbb{F}_2$ from a u64

pub fn value(&self) -> Uint<1>

Get the Uint<1> from an element of $\mathbb{F}_2$

pub fn as_u8(&self) -> u8

Get the u8 from an element of $\mathbb{F}_2$

Trait Implementations

impl Add for F2Element

type Output = F2Element

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for F2Element

fn clone(&self) -> F2Element

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for F2Element

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

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

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

impl ConstantTimeEq for F2Element

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for F2Element

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

Formats the value using the given formatter.

impl Default for F2Element

fn default() -> Self

Returns the “default value” for a type.

impl Display for F2Element

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

Formats the value using the given formatter.

impl FieldFromRepr for F2Element

type Repr = Uint<1>

The representation type accepted by this field.

fn from_repr(x: Self::Repr) -> Self

Constructs a field element from the given representation.

impl FieldOps for F2Element

fn zero() -> Self

Create the constant zero

fn one() -> Self

Create the constant one

fn from_u64(x: u64) -> Self

Convert u64 to the field.

fn is_zero(&self) -> Choice

Check if element is zero

fn is_one(&self) -> Choice

Check if element is one

fn negate(&self) -> Self

Negate self to -self

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

Add rhs to self

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

Sub rhs from self

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

Multipliy self by rhs

fn square(&self) -> Self

Square self

fn double(&self) -> Self

Double self

fn invert(&self) -> CtOption<Self>

Invert self

fn frobenius(&self) -> Self

Compute self^p the frobenius acting on self

fn norm(&self) -> Self

compute the norm of self down to $\mathbb{F}_p$ (as an element of type Self)

fn trace(&self) -> Self

compute the trace of self down to $\mathbb{F}_p$ (as an element of type Self)

fn sqrt(&self) -> CtOption<Self>

Returns a squareroot if it exists

fn legendre(&self) -> i8

Computes the “Legendre symbol” i.e., if 0,1,-1 depending if self is 0, a square or a nonsquare.

fn characteristic() -> Vec<u64>

Returns the characteristic of the field.

fn degree() -> u32

Returns the extension degree of the field.

fn div(&self, rhs: &Self) -> CtOption<Self>

Divide self by rhs

fn pow_vartime(&self, exp: &[u64]) -> Self

self^exp using square-and multiply (litte-endian bit order)

fn pow(&self, exp: &[u64]) -> Self

self^pow in constant time using a Montgomery ladder

fn frobenius_pow(&self, k: u32) -> Self

Compute self^{p^k} a power of the frobenius

fn inverse_and_sqrt(&self) -> (CtOption<Self>, CtOption<Self>)

Computes the inverse and square root of self

fn inv_sqrt(&self) -> CtOption<Self>

Computes the square root the inverse of self

fn invertme_sqrtother(&self, rhs: &Self) -> (CtOption<Self>, CtOption<Self>)

Computes the inverse of self and square root of rhs

fn sqrt_ratio(&self, rhs: &Self) -> CtOption<Self>

Computes the squareroot of a ratio self/rhs

impl FieldRandom for F2Element

fn random(rng: &mut (impl CryptoRng + Rng)) -> Self

Sample a uniformly random element using a cryptographic RNG.

impl Mul for F2Element

type Output = F2Element

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for F2Element

type Output = F2Element

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for F2Element

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

type Output = F2Element

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for F2Element

impl Eq for F2Element

impl StructuralPartialEq for F2Element