snarkvm_algorithms::fft::domain

Struct EvaluationDomain

Source
pub struct EvaluationDomain<F: FftField> {
    pub size: u64,
    pub log_size_of_group: u32,
    pub size_as_field_element: F,
    pub size_inv: F,
    pub group_gen: F,
    pub group_gen_inv: F,
    pub generator_inv: F,
}
Expand description

Defines a domain over which finite field (I)FFTs can be performed. Works only for fields that have a large multiplicative subgroup of size that is a power-of-2.

Fields§

§size: u64

The size of the domain.

§log_size_of_group: u32

log_2(self.size).

§size_as_field_element: F

Size of the domain as a field element.

§size_inv: F

Inverse of the size in the field.

§group_gen: F

A generator of the subgroup.

§group_gen_inv: F

Inverse of the generator of the subgroup.

§generator_inv: F

Inverse of the multiplicative generator of the finite field.

Implementations§

Source§

impl<F: FftField> EvaluationDomain<F>

Source

pub fn sample_element_outside_domain<R: Rng>(&self, rng: &mut R) -> F

Sample an element that is not in the domain.

Source

pub fn new(num_coeffs: usize) -> Option<Self>

Construct a domain that is large enough for evaluations of a polynomial having num_coeffs coefficients.

Source

pub fn compute_size_of_domain(num_coeffs: usize) -> Option<usize>

Return the size of a domain that is large enough for evaluations of a polynomial having num_coeffs coefficients.

Source

pub fn size(&self) -> usize

Return the size of self.

Source

pub fn fft<T: DomainCoeff<F>>(&self, coeffs: &[T]) -> Vec<T>

Compute an FFT.

Source

pub fn fft_in_place<T: DomainCoeff<F>>(&self, coeffs: &mut Vec<T>)

Compute an FFT, modifying the vector in place.

Source

pub fn ifft<T: DomainCoeff<F>>(&self, evals: &[T]) -> Vec<T>

Compute an IFFT.

Source

pub fn ifft_in_place<T: DomainCoeff<F>>(&self, evals: &mut Vec<T>)

Compute an IFFT, modifying the vector in place.

Source

pub fn coset_fft<T: DomainCoeff<F>>(&self, coeffs: &[T]) -> Vec<T>

Compute an FFT over a coset of the domain.

Source

pub fn coset_fft_in_place<T: DomainCoeff<F>>(&self, coeffs: &mut Vec<T>)

Compute an FFT over a coset of the domain, modifying the input vector in place.

Source

pub fn coset_ifft<T: DomainCoeff<F>>(&self, evals: &[T]) -> Vec<T>

Compute an IFFT over a coset of the domain.

Source

pub fn coset_ifft_in_place<T: DomainCoeff<F>>(&self, evals: &mut Vec<T>)

Compute an IFFT over a coset of the domain, modifying the input vector in place.

Source

pub fn evaluate_all_lagrange_coefficients(&self, tau: F) -> Vec<F>

Evaluate all the lagrange polynomials defined by this domain at the point tau.

Source

pub fn vanishing_polynomial(&self) -> SparsePolynomial<F>

Return the sparse vanishing polynomial.

Source

pub fn evaluate_vanishing_polynomial(&self, tau: F) -> F

This evaluates the vanishing polynomial for this domain at tau. For multiplicative subgroups, this polynomial is z(X) = X^self.size - 1.

Source

pub fn elements(&self) -> Elements<F>

Return an iterator over the elements of the domain.

Source

pub fn divide_by_vanishing_poly_on_coset_in_place(&self, evals: &mut [F])

The target polynomial is the zero polynomial in our evaluation domain, so we must perform division over a coset.

Source

pub fn reindex_by_subdomain(&self, other: &Self, index: usize) -> Result<usize>

Given an index in the other subdomain, return an index into this domain self This assumes the other’s elements are also self’s first elements

Source

pub fn mul_polynomials_in_evaluation_domain( &self, self_evals: Vec<F>, other_evals: &[F], ) -> Result<Vec<F>>

Perform O(n) multiplication of two polynomials that are presented by their evaluations in the domain. Returns the evaluations of the product over the domain.

Source§

impl<F: FftField> EvaluationDomain<F>

Source

pub fn precompute_fft(&self) -> FFTPrecomputation<F>

Source

pub fn precompute_ifft(&self) -> IFFTPrecomputation<F>

Source

pub fn in_order_fft_with_pc<T: DomainCoeff<F>>( &self, x_s: &[T], pc: &FFTPrecomputation<F>, ) -> Vec<T>

Source

pub fn roots_of_unity(&self, root: F) -> Vec<F>

Computes the first self.size / 2 roots of unity.

Trait Implementations§

Source§

impl<F: FftField> CanonicalDeserialize for EvaluationDomain<F>

Source§

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

Source§

fn deserialize_compressed<R>(reader: R) -> Result<Self, SerializationError>
where R: Read,

Source§

fn deserialize_compressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>
where R: Read,

Source§

fn deserialize_uncompressed<R>(reader: R) -> Result<Self, SerializationError>
where R: Read,

Source§

fn deserialize_uncompressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>
where R: Read,

Source§

impl<F: FftField> CanonicalSerialize for EvaluationDomain<F>

Source§

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

Source§

fn serialized_size(&self, compress: Compress) -> usize

Source§

fn serialize_compressed<W>(&self, writer: W) -> Result<(), SerializationError>
where W: Write,

Source§

fn compressed_size(&self) -> usize

Source§

fn serialize_uncompressed<W>(&self, writer: W) -> Result<(), SerializationError>
where W: Write,

Source§

fn uncompressed_size(&self) -> usize

Source§

impl<F: Clone + FftField> Clone for EvaluationDomain<F>

Source§

fn clone(&self) -> EvaluationDomain<F>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: FftField> Debug for EvaluationDomain<F>

Source§

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

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

impl<F: Hash + FftField> Hash for EvaluationDomain<F>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<F: PartialEq + FftField> PartialEq for EvaluationDomain<F>

Source§

fn eq(&self, other: &EvaluationDomain<F>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<F: FftField> Valid for EvaluationDomain<F>

Source§

fn check(&self) -> Result<(), SerializationError>

Source§

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>
where Self: 'a,

Source§

impl<F: Copy + FftField> Copy for EvaluationDomain<F>

Source§

impl<F: Eq + FftField> Eq for EvaluationDomain<F>

Source§

impl<F: FftField> StructuralPartialEq for EvaluationDomain<F>

Auto Trait Implementations§

§

impl<F> Freeze for EvaluationDomain<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for EvaluationDomain<F>
where F: RefUnwindSafe,

§

impl<F> Send for EvaluationDomain<F>

§

impl<F> Sync for EvaluationDomain<F>

§

impl<F> Unpin for EvaluationDomain<F>
where F: Unpin,

§

impl<F> UnwindSafe for EvaluationDomain<F>
where F: UnwindSafe,

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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