Skip to main content

Polynomial

Struct Polynomial 

Source
pub struct Polynomial { /* private fields */ }
Expand description

A polynomial over the ML-DSA ring.

Dev note: The following structure does not necessarily need to be declared as public. There is no real scenario where this function needs to be called directly. However, in order to test the Debug and Display traits, it is necessary to use STD, so those canโ€™t be tested from inline tests in this file and the real unit tests are in a different crate. Thatโ€™s the reason why pub is used.

ยง๐Ÿšจ Security ๐Ÿšจ

Polynomials themselves are not inherently secret since sometimes they are part of public keys and sometimes private keys. It is the responsibility of the caller to wrap sensitive instances in Secret<Polynomial>. Note: at the moment, nothing in this crate uses Secret<Polynomial>, so I have left the impl ZeroizablePrimitive commented-out.

Implementationsยง

Sourceยง

impl Polynomial

Source

pub const fn new() -> Self

Create a new polynomial with all coefficients set to zero.

Trait Implementationsยง

Sourceยง

impl Clone for Polynomial

Sourceยง

fn clone(&self) -> Polynomial

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Index<usize> for Polynomial

Convenience function to avoid โ€œ.0โ€ all over the place.

Sourceยง

type Output = i32

The returned type after indexing.
Sourceยง

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Sourceยง

impl IndexMut<usize> for Polynomial

Convenience function to avoid โ€œ.0โ€ all over the place.

Sourceยง

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Sourceยง

impl Copy for Polynomial

Auto Trait Implementationsยง

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> 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.