Skip to main content

FactoredMultilinear

Struct FactoredMultilinear 

Source
pub struct FactoredMultilinear<P: PackedField, Data: BufferData<P> = Vec<P>> { /* private fields */ }
Expand description

A multilinear that factorizes across disjoint runs of its variables.

Some weights are a product of small pieces rather than one table. An equality indicator over several axes factorizes across them, for instance.

Storing such a weight whole costs the product of the pieces’ lengths. Storing the pieces costs their sum.

    whole:   2^(n_1 + n_2 + n_3) entries
    factors: 2^n_1 + 2^n_2 + 2^n_3 entries

The saving is what lets a sumcheck range over a space far too large to materialize, so long as nothing ever asks for the whole table at once.

§Variable order

Factors are held lowest run first.

A factor over n variables owns the next n bits of the index, above the bits the factors before it own. So the last factor owns the highest variables, and is the one a fold consumes first.

    index = [ factor 0 bits | factor 1 bits | ... | last factor bits ]
              lowest                                       highest

§Examples

ⓘ
// A weight over an operand axis, a shift axis, and a value axis.
let mut weight = FactoredMultilinear::new(vec![operand, shift, value]);
let at_index = weight.get(index);
weight.fold_highest_var(challenge);

Where the factors’ packed words live.

Defaults to the heap, and the point of the parameter is that it need not be.

A caller proving out of an arena hands over arena-backed factors. This holds them as they are, rather than forcing a copy onto the heap.

Implementations§

Source§

impl<P: PackedField, Data: BufferData<P>> FactoredMultilinear<P, Data>

Source

pub fn new(factors: impl IntoIterator<Item = FieldBuffer<P, Data>>) -> Self

Builds a multilinear from its factors, lowest variable run first.

A factor with no variables is folded straight into the bound product rather than kept, since it holds a value and no axis.

Source

pub fn n_vars(&self) -> usize

The number of variables still free.

Source

pub fn get(&self, index: usize) -> P::Scalar

The value at one vertex of the hypercube over the free variables.

Each factor reads the bits it owns, and the results multiply. So a lookup costs one multiplication per factor rather than one per variable.

§Panics

Panics if the index does not fit the free variables.

Source

pub fn fold_highest_var(&mut self, challenge: P::Scalar)

Fixes the highest free variable to a value.

The highest variable belongs to the last factor, so that is the factor this folds. A factor whose variables are all bound holds one value, which moves into the bound product.

§Panics

Panics if no variable is free.

Trait Implementations§

Source§

impl<P: Clone + PackedField, Data: Clone + BufferData<P>> Clone for FactoredMultilinear<P, Data>
where P::Scalar: Clone,

Source§

fn clone(&self) -> FactoredMultilinear<P, Data>

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<P: Debug + PackedField, Data: Debug + BufferData<P>> Debug for FactoredMultilinear<P, Data>
where P::Scalar: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P, Data> Freeze for FactoredMultilinear<P, Data>
where <P as FieldOps>::Scalar: Freeze,

§

impl<P, Data> RefUnwindSafe for FactoredMultilinear<P, Data>

§

impl<P, Data> Send for FactoredMultilinear<P, Data>
where Data: Send,

§

impl<P, Data> Sync for FactoredMultilinear<P, Data>
where Data: Sync,

§

impl<P, Data> Unpin for FactoredMultilinear<P, Data>
where <P as FieldOps>::Scalar: Unpin, Data: Unpin,

§

impl<P, Data> UnsafeUnpin for FactoredMultilinear<P, Data>
where <P as FieldOps>::Scalar: UnsafeUnpin,

§

impl<P, Data> UnwindSafe for FactoredMultilinear<P, Data>
where <P as FieldOps>::Scalar: UnwindSafe, Data: 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.

§

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