binius_math

Enum ArithExpr

Source
pub enum ArithExpr<F: Field> {
    Const(F),
    Var(usize),
    Add(Box<ArithExpr<F>>, Box<ArithExpr<F>>),
    Mul(Box<ArithExpr<F>>, Box<ArithExpr<F>>),
    Pow(Box<ArithExpr<F>>, u64),
}
Expand description

Arithmetic expressions that can be evaluated symbolically.

Arithmetic expressions are trees, where the leaves are either constants or variables, and the non-leaf nodes are arithmetic operations, such as addition, multiplication, etc. They are specific representations of multivariate polynomials.

Variants§

§

Const(F)

§

Var(usize)

§

Add(Box<ArithExpr<F>>, Box<ArithExpr<F>>)

§

Mul(Box<ArithExpr<F>>, Box<ArithExpr<F>>)

§

Pow(Box<ArithExpr<F>>, u64)

Implementations§

Source§

impl<F: Field> ArithExpr<F>

Source

pub fn n_vars(&self) -> usize

The number of variables the expression contains.

Source

pub fn degree(&self) -> usize

The total degree of the polynomial the expression represents.

Source

pub fn pow(self, exp: u64) -> Self

Source

pub const fn zero() -> Self

Source

pub const fn one() -> Self

Source

pub fn remap_vars(self, indices: &[usize]) -> Result<Self, Error>

Creates a new expression with the variable indices remapped.

This recursively replaces the variable sub-expressions with an index i with the variable indices[i].

§Throws
Source

pub fn convert_field<FTgt: Field + From<F>>(&self) -> ArithExpr<FTgt>

Source

pub fn try_convert_field<FTgt: Field + TryFrom<F>>( &self, ) -> Result<ArithExpr<FTgt>, <FTgt as TryFrom<F>>::Error>

Trait Implementations§

Source§

impl<F> Add for ArithExpr<F>
where F: Field,

Source§

type Output = ArithExpr<F>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl<F> AddAssign for ArithExpr<F>
where F: Field,

Source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
Source§

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

Source§

fn clone(&self) -> ArithExpr<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: Debug + Field> Debug for ArithExpr<F>

Source§

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

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

impl<F> Default for ArithExpr<F>
where F: Field,

Source§

fn default() -> Self

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

impl<F: Field + Display> Display for ArithExpr<F>

Source§

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

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

impl<F> Mul for ArithExpr<F>
where F: Field,

Source§

type Output = ArithExpr<F>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl<F> MulAssign for ArithExpr<F>
where F: Field,

Source§

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more
Source§

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

Source§

fn eq(&self, other: &ArithExpr<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> Product for ArithExpr<F>

Source§

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<F> Sub for ArithExpr<F>
where F: Field,

Source§

type Output = ArithExpr<F>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl<F> SubAssign for ArithExpr<F>
where F: Field,

Source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
Source§

impl<F: Field> Sum for ArithExpr<F>

Source§

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<F> Freeze for ArithExpr<F>
where <F as WithUnderlier>::Underlier: Sized, F: Freeze,

§

impl<F> RefUnwindSafe for ArithExpr<F>

§

impl<F> Send for ArithExpr<F>
where <F as WithUnderlier>::Underlier: Sized,

§

impl<F> Sync for ArithExpr<F>
where <F as WithUnderlier>::Underlier: Sized,

§

impl<F> Unpin for ArithExpr<F>
where <F as WithUnderlier>::Underlier: Sized, F: Unpin,

§

impl<F> UnwindSafe for ArithExpr<F>

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more