Struct Shape 

pub struct Shape<K: Clone + Eq + Hash> {
    pub inner: HashMap<K, usize>,
}

A way to keep track of the log2 heights of some set of chips.

Fields

inner: HashMap<K, usize>

The nonzero log2 heights of each chip.

Implementations

impl<K: Clone + Eq + Hash + FromStr> Shape<K>

pub fn new(inner: HashMap<K, usize>) -> Self

Create a new empty shape.

pub fn from_log2_heights(log2_heights: &[(K, usize)]) -> Self

Create a shape from a list of log2 heights.

pub fn from_traces<V: Clone + Send + Sync>( traces: &[(K, RowMajorMatrix<V>)], ) -> Self

Create a shape from a list of traces.

pub fn len(&self) -> usize

The number of chips in the shape.

pub fn is_empty(&self) -> bool

Whether the shape is empty.

pub fn height(&self, key: &K) -> Option<usize>

Get the height of a given key.

pub fn log2_height(&self, key: &K) -> Option<usize>

Get the log2 height of a given key.

pub fn contains(&self, key: &K) -> bool

Whether the shape includes a given key.

pub fn insert(&mut self, key: K, height: usize)

Insert a key-height pair into the shape.

pub fn included<F: PrimeField, A: MachineAir<F>>(&self, air: &A) -> bool

where <K as FromStr>::Err: Debug,

Whether the shape includes a given AIR.

TODO: Deprecate by adding air.id().

pub fn iter(&self) -> impl Iterator<Item = (&K, &usize)>

Get an iterator over the shape.

pub fn estimate_lde_size(&self, costs: &HashMap<K, usize>) -> usize

Estimate the lde size.

WARNING: This is a heuristic, it may not be completely accurate. To be 100% sure that they OOM, you should run the shape through the prover.

Trait Implementations

impl<K: Clone + Clone + Eq + Hash> Clone for Shape<K>

fn clone(&self) -> Shape<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Clone + Eq + Hash> Debug for Shape<K>

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

Formats the value using the given formatter.

impl<K: Clone + Eq + Hash> Default for Shape<K>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K> Deserialize<'de> for Shape<K>

where K: Deserialize<'de> + Clone + Eq + Hash,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: Clone + Eq + Hash> Extend<(K, usize)> for Shape<K>

fn extend<T: IntoIterator<Item = (K, usize)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Clone + Eq + Hash> Extend<Shape<K>> for Shape<K>

fn extend<T: IntoIterator<Item = Shape<K>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Clone + Eq + Hash + FromStr> FromIterator<(K, usize)> for Shape<K>

fn from_iter<T: IntoIterator<Item = (K, usize)>>(iter: T) -> Self

Creates a value from an iterator.

impl<K: Clone + Eq + Hash> IntoIterator for Shape<K>

type Item = (K, usize)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, usize>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: PartialEq + Clone + Eq + Hash> PartialEq for Shape<K>

fn eq(&self, other: &Shape<K>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: Clone + Eq + Hash> PartialOrd for Shape<K>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K> Serialize for Shape<K>

where K: Serialize + Clone + Eq + Hash,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: Clone + Eq + Hash> StructuralPartialEq for Shape<K>