Skip to main content

NttPolynomial

Struct NttPolynomial 

Source
pub struct NttPolynomial<F: Field>(pub Array<Elem<F>, U256>);
Expand description

An NttPolynomial is a member of the NTT algebra T_q = Z_q[X]^256 of 256-tuples of field elements.

NTT polynomials can be added and subtracted, negated, and multiplied by scalars. We do not define multiplication of NTT polynomials here: that is defined by the downstream crate using the MultiplyNtt trait.

We also do not define the mappings between normal polynomials and NTT polynomials (i.e., between R_q and T_q).

Tuple Fields§

§0: Array<Elem<F>, U256>

Implementations§

Source§

impl<F: Field> NttPolynomial<F>

Source

pub const fn new(x: Array<Elem<F>, U256>) -> Self

Create a new NTT polynomial.

Trait Implementations§

Source§

impl<F: Field> Add<&NttPolynomial<F>> for &NttPolynomial<F>

Source§

type Output = NttPolynomial<F>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &NttPolynomial<F>) -> NttPolynomial<F>

Performs the + operation. Read more
Source§

impl<F: Clone + Field> Clone for NttPolynomial<F>

Source§

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

Returns a duplicate 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: Field> ConstantTimeEq for NttPolynomial<F>
where F::Int: ConstantTimeEq,

Available on crate feature subtle only.
Source§

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

Determine if two items are equal. Read more
Source§

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

Determine if two items are NOT equal. Read more
Source§

impl<F: Debug + Field> Debug for NttPolynomial<F>

Source§

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

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

impl<F: Default + Field> Default for NttPolynomial<F>

Source§

fn default() -> NttPolynomial<F>

Returns the “default value” for a type. Read more
Source§

impl<F: Field, D: EncodingSize> Encode<D> for NttPolynomial<F>

Source§

type EncodedSize = <D as EncodingSize>::EncodedPolynomialSize

Size of the encoded object.
Source§

fn encode(&self) -> Array<u8, Self::EncodedSize>

Encode object.
Source§

fn decode(enc: &Array<u8, Self::EncodedSize>) -> Self

Decode object.
Source§

impl<F: Field> From<Array<Elem<F>, UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>, B0>, B0>>> for NttPolynomial<F>

Source§

fn from(f: Array<Elem<F>, U256>) -> NttPolynomial<F>

Converts to this type from the input type.
Source§

impl<F: Field> From<NttPolynomial<F>> for Array<Elem<F>, U256>

Source§

fn from(f_hat: NttPolynomial<F>) -> Array<Elem<F>, U256>

Converts to this type from the input type.
Source§

impl<F> Mul<&NttPolynomial<F>> for &NttPolynomial<F>
where F: Field + MultiplyNtt,

Source§

type Output = NttPolynomial<F>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &NttPolynomial<F>) -> NttPolynomial<F>

Performs the * operation. Read more
Source§

impl<F: Field> Mul<&NttPolynomial<F>> for Elem<F>

Source§

type Output = NttPolynomial<F>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &NttPolynomial<F>) -> NttPolynomial<F>

Performs the * operation. Read more
Source§

impl<F: Field, K: ArraySize> Mul<&NttVector<F, K>> for &NttPolynomial<F>
where for<'a> &'a NttPolynomial<F>: Mul<&'a NttPolynomial<F>, Output = NttPolynomial<F>>,

Source§

type Output = NttVector<F, K>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &NttVector<F, K>) -> NttVector<F, K>

Performs the * operation. Read more
Source§

impl<F: Field> Neg for &NttPolynomial<F>

Source§

type Output = NttPolynomial<F>

The resulting type after applying the - operator.
Source§

fn neg(self) -> NttPolynomial<F>

Performs the unary - operation. Read more
Source§

impl<F: PartialEq + Field> PartialEq for NttPolynomial<F>

Source§

fn eq(&self, other: &NttPolynomial<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: Field> Sub<&NttPolynomial<F>> for &NttPolynomial<F>

Source§

type Output = NttPolynomial<F>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &NttPolynomial<F>) -> NttPolynomial<F>

Performs the - operation. Read more
Source§

impl<F: Field> Zeroize for NttPolynomial<F>
where F::Int: Zeroize,

Available on crate feature zeroize only.
Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.
Source§

impl<F: Eq + Field> Eq for NttPolynomial<F>

Source§

impl<F: Field> StructuralPartialEq for NttPolynomial<F>

Auto Trait Implementations§

§

impl<F> Freeze for NttPolynomial<F>
where <F as Field>::Int: Freeze,

§

impl<F> RefUnwindSafe for NttPolynomial<F>
where <F as Field>::Int: RefUnwindSafe,

§

impl<F> Send for NttPolynomial<F>
where <F as Field>::Int: Send,

§

impl<F> Sync for NttPolynomial<F>
where <F as Field>::Int: Sync,

§

impl<F> Unpin for NttPolynomial<F>
where <F as Field>::Int: Unpin,

§

impl<F> UnwindSafe for NttPolynomial<F>
where <F as Field>::Int: 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.