Struct amcl_wrapper::univar_poly::UnivarPolynomial

pub struct UnivarPolynomial(pub FieldElementVector);

Univariate polynomial represented with coefficients in a vector. The ith element of the vector is the coefficient of the ith degree term.

Implementations

impl UnivarPolynomial

pub fn new(degree: usize) -> Self

Return a zero polynomial of degree degree

pub fn new_constant(constant: FieldElement) -> Self

Return a constant polynomial

pub fn random(degree: usize) -> Self

Return a randomly chosen polynomial (each coefficient is randomly chosen) of degree degree.

pub fn new_with_roots(roots: &[FieldElement]) -> Self

Create a polynomial with given roots in roots i.e. (x-roots[0])(x-roots[1])(x-roots[2])...(x-roots[last]) given roots

pub fn coefficients(&self) -> &FieldElementVector

pub fn degree(&self) -> usize

pub fn is_zero(&self) -> bool

Polynomial is zero if all coefficients are 0

pub fn eval(&self, x: &FieldElement) -> FieldElement

pub fn long_division(dividend: &Self, divisor: &Self) -> (Self, Self)

Divides 2 polynomials i.e. dividend / divisor using long division. Returns (quotient, remainder)

pub fn multiply(left: &Self, right: &Self) -> Self

Return product of 2 polynomials. left * right

pub fn sum(left: &Self, right: &Self) -> Self

Return sum of 2 polynomials. left + right

pub fn difference(left: &Self, right: &Self) -> Self

Return difference of 2 polynomials. left - right

pub fn multiply_by_constant(&self, constant: &FieldElement) -> UnivarPolynomial

pub fn multiply_by_monic_monomial(
    &self,
    monomial_degree: u64
) -> UnivarPolynomial

Trait Implementations

impl<'a, '_> Add<&'a UnivarPolynomial> for &'_ UnivarPolynomial

type Output = UnivarPolynomial

The resulting type after applying the + operator.

fn add(self, other: &'a UnivarPolynomial) -> UnivarPolynomial

Performs the + operation.

impl Clone for UnivarPolynomial

fn clone(&self) -> UnivarPolynomial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnivarPolynomial

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnivarPolynomial

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for UnivarPolynomial

impl Index<usize> for UnivarPolynomial

type Output = FieldElement

The returned type after indexing.

fn index(&self, idx: usize) -> &FieldElement

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for UnivarPolynomial

fn index_mut(&mut self, idx: usize) -> &mut FieldElement

Performs the mutable indexing (container[index]) operation.

impl<'a, '_> Mul<&'a UnivarPolynomial> for &'_ UnivarPolynomial

type Output = UnivarPolynomial

The resulting type after applying the * operator.

fn mul(self, other: &'a UnivarPolynomial) -> UnivarPolynomial

Performs the * operation.

impl PartialEq<UnivarPolynomial> for UnivarPolynomial

fn eq(&self, other: &UnivarPolynomial) -> bool

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

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

This method tests for !=.

impl Serialize for UnivarPolynomial

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnivarPolynomial

impl<'a, '_> Sub<&'a UnivarPolynomial> for &'_ UnivarPolynomial

type Output = UnivarPolynomial

The resulting type after applying the - operator.

fn sub(self, other: &'a UnivarPolynomial) -> UnivarPolynomial

Performs the - operation.