Struct winter_math::fields::CubeExtension

#[repr(C)]
pub struct CubeExtension<B: ExtensibleField<3>>(/* private fields */);

Represents an element in a cubic extension of a StarkField.

The extension element is defined as α + β * φ + γ * φ^2, where φ is a root of in irreducible polynomial defined by the implementation of the ExtensibleField trait, and α, β, γ are base field elements.

Implementations

impl<B: ExtensibleField<3>> CubeExtension<B>

pub const fn new(a: B, b: B, c: B) -> Self

Returns a new extension element instantiated from the provided base elements.

pub fn is_supported() -> bool

Returns true if the base field specified by B type parameter supports cubic extensions.

pub const fn to_base_elements(self) -> [B; 3]

Returns an array of base field elements comprising this extension field element.

The order of abase elements in the returned array is the same as the order in which the elements are provided to the CubeExtension::new() constructor.

Trait Implementations

impl<B: ExtensibleField<3>> Add for CubeExtension<B>

type Output = CubeExtension<B>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<B: ExtensibleField<3>> AddAssign for CubeExtension<B>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<B: ExtensibleField<3>> AsBytes for CubeExtension<B>

fn as_bytes(&self) -> &[u8]

Returns a byte representation of self.

impl<B: Clone + ExtensibleField<3>> Clone for CubeExtension<B>

fn clone(&self) -> CubeExtension<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + ExtensibleField<3>> Debug for CubeExtension<B>

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

Formats the value using the given formatter.

impl<B: Default + ExtensibleField<3>> Default for CubeExtension<B>

fn default() -> CubeExtension<B>

Returns the “default value” for a type.

impl<B: ExtensibleField<3>> Deserializable for CubeExtension<B>

fn read_from<R: ByteReader>( source: &mut R ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl<B: ExtensibleField<3>> Display for CubeExtension<B>

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

Formats the value using the given formatter.

impl<B: ExtensibleField<3>> Div for CubeExtension<B>

type Output = CubeExtension<B>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<B: ExtensibleField<3>> DivAssign for CubeExtension<B>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<B: ExtensibleField<3>> ExtensionOf<B> for CubeExtension<B>

fn mul_base(self, other: B) -> Self

impl<B: ExtensibleField<3>> FieldElement for CubeExtension<B>

type PositiveInteger = <B as FieldElement>::PositiveInteger

A type defining positive integers big enough to describe a field modulus for Self::BaseField with no loss of precision.

type BaseField = B

Base field type for this finite field. For prime fields, BaseField should be set to Self.

const EXTENSION_DEGREE: usize = 3usize

Extension degree of this field with respect to Self::BaseField. For prime fields, extension degree should be set to 1.

const ELEMENT_BYTES: usize = _

Number of bytes needed to encode an element

const IS_CANONICAL: bool = B::IS_CANONICAL

True if internal representation of the element is the same as its canonical representation.

const ZERO: Self = _

The additive identity.

const ONE: Self = _

The multiplicative identity.

fn double(self) -> Self

Returns this field element added to itself.

fn square(self) -> Self

Returns this field element raised to power 2.

fn inv(self) -> Self

Returns a multiplicative inverse of this field element. If this element is ZERO, ZERO is returned.

fn conjugate(&self) -> Self

Returns a conjugate of this field element.

fn base_element(&self, i: usize) -> Self::BaseField

Return base filed element component of this field element at the specified index i.

fn slice_as_base_elements(elements: &[Self]) -> &[Self::BaseField]

Converts a slice of field elements into a slice of elements in the underlying base field.

fn slice_from_base_elements(elements: &[Self::BaseField]) -> &[Self]

Convert a slice of base field elements into a slice of field elements.

fn elements_as_bytes(elements: &[Self]) -> &[u8]

Converts a list of elements into a list of bytes.

unsafe fn bytes_as_elements( bytes: &[u8] ) -> Result<&[Self], DeserializationError>

Converts a list of bytes into a list of field elements.

fn cube(self) -> Self

Returns this field element raised to power 3.

fn exp(self, power: Self::PositiveInteger) -> Self

Exponentiates this field element by power parameter.

fn exp_vartime(self, power: Self::PositiveInteger) -> Self

Exponentiates this field element by power parameter. This function is expressly variable time, to speed-up verifier computations.

impl<B: ExtensibleField<3>> From<B> for CubeExtension<B>

fn from(value: B) -> Self

Converts to this type from the input type.

impl<B: ExtensibleField<3>> From<u16> for CubeExtension<B>

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<B: ExtensibleField<3>> From<u32> for CubeExtension<B>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<B: ExtensibleField<3>> From<u8> for CubeExtension<B>

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<B: ExtensibleField<3>> Mul for CubeExtension<B>

type Output = CubeExtension<B>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<B: ExtensibleField<3>> MulAssign for CubeExtension<B>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<B: ExtensibleField<3>> Neg for CubeExtension<B>

type Output = CubeExtension<B>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<B: PartialEq + ExtensibleField<3>> PartialEq for CubeExtension<B>

fn eq(&self, other: &CubeExtension<B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: ExtensibleField<3>> Randomizable for CubeExtension<B>

const VALUE_SIZE: usize = Self::ELEMENT_BYTES

Size of Self in bytes.

fn from_random_bytes(bytes: &[u8]) -> Option<Self>

Returns Self if the set of bytes forms a valid value, otherwise returns None.

impl<B: ExtensibleField<3>> Serializable for CubeExtension<B>

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl<B: ExtensibleField<3>> Sub for CubeExtension<B>

type Output = CubeExtension<B>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<B: ExtensibleField<3>> SubAssign for CubeExtension<B>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a, B: ExtensibleField<3>> TryFrom<&'a [u8]> for CubeExtension<B>

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Converts a slice of bytes into a field element; returns error if the value encoded in bytes is not a valid field element. The bytes are assumed to be in little-endian byte order.

type Error = DeserializationError

The type returned in the event of a conversion error.

impl<B: ExtensibleField<3>> TryFrom<u128> for CubeExtension<B>

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl<B: ExtensibleField<3>> TryFrom<u64> for CubeExtension<B>

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl<B: Copy + ExtensibleField<3>> Copy for CubeExtension<B>

impl<B: Eq + ExtensibleField<3>> Eq for CubeExtension<B>

impl<B: ExtensibleField<3>> StructuralPartialEq for CubeExtension<B>