IsPrimeField

lambdaworks_math::field::traits

Trait IsPrimeField 

Source 
pub trait IsPrimeField: IsField {
    type RepresentativeType: IsUnsignedInteger;

    // Required methods
    fn representative(a: &Self::BaseType) -> Self::RepresentativeType;
    fn from_hex(hex_string: &str) -> Result<Self::BaseType, CreationError>;
    fn to_hex(a: &Self::BaseType) -> String;
    fn field_bit_size() -> usize;

    // Provided methods
    fn modulus_minus_one() -> Self::RepresentativeType { ... }
    fn legendre_symbol(a: &Self::BaseType) -> LegendreSymbol { ... }
    fn sqrt(a: &Self::BaseType) -> Option<(Self::BaseType, Self::BaseType)> { ... }
}

Required Associated Types§

Source

type RepresentativeType: IsUnsignedInteger

Required Methods§

Source

fn representative(a: &Self::BaseType) -> Self::RepresentativeType

Returns the integer representative in the range [0, p-1], where p the modulus

Source

fn from_hex(hex_string: &str) -> Result<Self::BaseType, CreationError>

Creates a BaseType from a Hex String 0x is optional Returns an CreationError::InvalidHexStringif the value is not a hexstring

Source

fn to_hex(a: &Self::BaseType) -> String

Creates a hexstring from a FieldElement without 0x.

Source

fn field_bit_size() -> usize

Returns the number of bits of the max element of the field, as per field documentation, not internal representation. This is log2(max FE) rounded up

Provided Methods§

Source

fn modulus_minus_one() -> Self::RepresentativeType

Returns p - 1, which is -1 mod p

Source

fn legendre_symbol(a: &Self::BaseType) -> LegendreSymbol

Computes the Legendre symbol using Euler’s criterion This is important to ensure that we find the square root of elements that are quadratic residues

Source

fn sqrt(a: &Self::BaseType) -> Option<(Self::BaseType, Self::BaseType)>

Returns the two square roots of self if they exist and None otherwise

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§