Struct BinomialExtensionField

pub struct BinomialExtensionField<FA, const D: usize> { /* private fields */ }

Implementations

impl<FA: FieldAlgebra> BinomialExtensionField<FA, 2>

Convenience methods for complex extensions

pub const fn new(real: FA, imag: FA) -> Self

pub const fn new_real(real: FA) -> Self

pub const fn new_imag(imag: FA) -> Self

pub fn real(&self) -> FA

pub fn imag(&self) -> FA

pub fn conjugate(&self) -> Self

pub fn norm(&self) -> FA

pub fn to_array(&self) -> [FA; 2]

pub fn rotate<Ext: FieldExtensionAlgebra<FA>>( &self, rhs: Complex<Ext>, ) -> Complex<Ext>

Trait Implementations

impl<FA, const D: usize> Add<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<FA, const D: usize> Add for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<FA, const D: usize> AddAssign<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn add_assign(&mut self, rhs: FA)

Performs the += operation.

impl<FA, const D: usize> AddAssign for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<FA: Clone, const D: usize> Clone for BinomialExtensionField<FA, D>

fn clone(&self) -> BinomialExtensionField<FA, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FA: Debug, const D: usize> Debug for BinomialExtensionField<FA, D>

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

Formats the value using the given formatter.

impl<FA: FieldAlgebra, const D: usize> Default for BinomialExtensionField<FA, D>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, FA, const D: usize> Deserialize<'de> for BinomialExtensionField<FA, D>

where FA: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F, const D: usize> Display for BinomialExtensionField<F, D>

where F: BinomiallyExtendable<D>,

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

Formats the value using the given formatter.

impl<F: BinomiallyExtendable<D>, const D: usize> Distribution<BinomialExtensionField<F, D>> for Standard

where Standard: Distribution<F>,

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> BinomialExtensionField<F, D>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<F, const D: usize> Div for BinomialExtensionField<F, D>

where F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<F, D>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<F, const D: usize> DivAssign for BinomialExtensionField<F, D>

where F: BinomiallyExtendable<D>,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<F: BinomiallyExtendable<D>, const D: usize> ExtensionField<F> for BinomialExtensionField<F, D>

type ExtensionPacking = BinomialExtensionField<<F as Field>::Packing, D>

fn is_in_basefield(&self) -> bool

fn as_base(&self) -> Option<Base>

fn ext_powers_packed(&self) -> Powers<Self::ExtensionPacking>

Construct an iterator which returns powers of self packed into ExtensionPacking elements.

impl<F: BinomiallyExtendable<D>, const D: usize> Field for BinomialExtensionField<F, D>

const GENERATOR: Self

A generator of this field’s entire multiplicative group.

type Packing = BinomialExtensionField<F, D>

fn try_inverse(&self) -> Option<Self>

The multiplicative inverse of this field element, if it exists.

fn halve(&self) -> Self

Computes input/2. Should be overwritten by most field implementations to use bitshifts. Will error if the field characteristic is 2.

fn order() -> BigUint

fn is_zero(&self) -> bool

fn is_one(&self) -> bool

fn div_2exp_u64(&self, exp: u64) -> Self

self / 2^exp

fn exp_u64_generic<FA: FieldAlgebra<F = Self>>(val: FA, power: u64) -> FA

Exponentiation by a u64 power. This is similar to exp_u64, but more general in that it can be used with FieldAlgebras, not just this concrete field.

fn inverse(&self) -> Self

fn multiplicative_group_factors() -> Vec<(BigUint, usize)>

A list of (factor, exponent) pairs.

fn bits() -> usize

impl<FA, const D: usize> FieldAlgebra for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

const ZERO: Self

The additive identity of the algebra.

const ONE: Self

The multiplicative identity of the Algebra

const TWO: Self

The element in the algebra given by ONE + ONE.

const NEG_ONE: Self

The element in the algebra given by -ONE.

type F = BinomialExtensionField<<FA as FieldAlgebra>::F, D>

fn from_f(f: Self::F) -> Self

Interpret a field element as a commutative algebra element.

fn from_canonical_u8(n: u8) -> Self

Convert from a canonical u8.

fn from_canonical_u16(n: u16) -> Self

Convert from a canonical u16.

fn from_canonical_u32(n: u32) -> Self

Convert from a canonical u32.

fn from_canonical_u64(n: u64) -> Self

Convert from a canonical u64.

fn from_canonical_usize(n: usize) -> Self

Convert from a canonical usize.

fn from_wrapped_u32(n: u32) -> Self

fn from_wrapped_u64(n: u64) -> Self

fn square(&self) -> Self

The elementary function square(a) = a^2.

fn zero_vec(len: usize) -> Vec<Self>

Allocates a vector of zero elements of length len. Many operating systems zero pages before assigning them to a userspace process. In that case, our process should not need to write zeros, which would be redundant. However, the compiler may not always recognize this.

fn from_bool(b: bool) -> Self

Convert from a bool.

fn double(&self) -> Self

The elementary function double(a) = 2*a.

fn cube(&self) -> Self

The elementary function cube(a) = a^3.

fn exp_u64(&self, power: u64) -> Self

Exponentiation by a u64 power.

fn exp_const_u64<const POWER: u64>(&self) -> Self

Exponentiation by a constant power.

fn exp_power_of_2(&self, power_log: usize) -> Self

Compute self^{2^power_log} by repeated squaring.

fn mul_2exp_u64(&self, exp: u64) -> Self

self * 2^exp

fn powers(&self) -> Powers<Self>

Construct an iterator which returns powers of self: self^0, self^1, self^2, ....

fn shifted_powers(&self, start: Self) -> Powers<Self>

Construct an iterator which returns powers of self shifted by start: start, start*self^1, start*self^2, ....

fn powers_packed<P: PackedField<Scalar = Self>>(&self) -> Powers<P>

Construct an iterator which returns powers of self packed into PackedField elements.

fn shifted_powers_packed<P: PackedField<Scalar = Self>>( &self, start: Self, ) -> Powers<P>

Construct an iterator which returns powers of self shifted by start and packed into PackedField elements.

fn dot_product<const N: usize>(u: &[Self; N], v: &[Self; N]) -> Self

Compute the dot product of two vectors.

impl<FA, const D: usize> FieldExtensionAlgebra<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

const D: usize = D

fn from_base(b: FA) -> Self

fn from_base_slice(bs: &[FA]) -> Self

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function takes a slice bs of length at exactly D, and constructs the field element \sum_i bs[i] * X^i.

fn from_base_fn<F: FnMut(usize) -> FA>(f: F) -> Self

Similar to core:array::from_fn, with the same caveats as from_base_slice.

fn from_base_iter<I: Iterator<Item = FA>>(iter: I) -> Self

fn as_base_slice(&self) -> &[FA]

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function takes a field element \sum_i bs[i] * X^i and returns the coefficients as a slice bs of length at most D containing, from lowest degree to highest.

fn monomial(exponent: usize) -> Self

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function returns the field element X^exponent if exponent < D and panics otherwise. (The fact that f is not known at the point that this function is defined prevents implementing exponentiation of higher powers since the reduction cannot be performed.)

impl<FA: FieldAlgebra, const D: usize> From<FA> for BinomialExtensionField<FA, D>

fn from(x: FA) -> Self

Converts to this type from the input type.

impl<F: BinomiallyExtendable<D>, const D: usize> HasFrobenius<F> for BinomialExtensionField<F, D>

fn frobenius(&self) -> Self

FrobeniusField automorphisms: x -> x^n, where n is the order of BaseField.

fn repeated_frobenius(&self, count: usize) -> Self

Repeated Frobenius automorphisms: x -> x^(n^count).

Follows precomputation suggestion in Section 11.3.3 of the Handbook of Elliptic and Hyperelliptic Curve Cryptography.

fn frobenius_inv(&self) -> Self

Algorithm 11.3.4 in Handbook of Elliptic and Hyperelliptic Curve Cryptography.

fn minimal_poly(self) -> Vec<F>

fn galois_group(self) -> Vec<Self>

impl<FA: Hash, const D: usize> Hash for BinomialExtensionField<FA, D>

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<FA, const D: usize> Mul<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<FA, const D: usize> Mul for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<FA, const D: usize> MulAssign<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn mul_assign(&mut self, rhs: FA)

Performs the *= operation.

impl<FA, const D: usize> MulAssign for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<FA, const D: usize> Neg for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<FA: Ord, const D: usize> Ord for BinomialExtensionField<FA, D>

fn cmp(&self, other: &BinomialExtensionField<FA, D>) -> 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<FA: PartialEq, const D: usize> PartialEq for BinomialExtensionField<FA, D>

fn eq(&self, other: &BinomialExtensionField<FA, D>) -> 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<FA: PartialOrd, const D: usize> PartialOrd for BinomialExtensionField<FA, D>

fn partial_cmp(&self, other: &BinomialExtensionField<FA, D>) -> 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<FA, const D: usize> Product for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<FA, const D: usize> Serialize for BinomialExtensionField<FA, D>

where FA: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<FA, const D: usize> Sub<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<FA, const D: usize> Sub for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

type Output = BinomialExtensionField<FA, D>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<FA, const D: usize> SubAssign<FA> for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn sub_assign(&mut self, rhs: FA)

Performs the -= operation.

impl<FA, const D: usize> SubAssign for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<FA, const D: usize> Sum for BinomialExtensionField<FA, D>

where FA: FieldAlgebra, FA::F: BinomiallyExtendable<D>,

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<F: Field + HasTwoAdicBinomialExtension<D>, const D: usize> TwoAdicField for BinomialExtensionField<F, D>

const TWO_ADICITY: usize = F::EXT_TWO_ADICITY

The number of factors of two in this field’s multiplicative group.

fn two_adic_generator(bits: usize) -> Self

Returns a generator of the multiplicative group of order 2^bits. Assumes bits <= TWO_ADICITY, otherwise the result is undefined.

impl<FA: Copy, const D: usize> Copy for BinomialExtensionField<FA, D>

impl<FA: Eq, const D: usize> Eq for BinomialExtensionField<FA, D>

impl<F: BinomiallyExtendable<D>, const D: usize> Packable for BinomialExtensionField<F, D>

impl<FA, const D: usize> StructuralPartialEq for BinomialExtensionField<FA, D>