Struct fullcodec_plonk::plonkup::MultiSet

pub struct MultiSet(pub Vec<BlsScalar>);

MultiSet is struct containing vectors of scalars, which individually represents either a wire value or an index of a Plonkup table

Tuple Fields

0: Vec<BlsScalar>

Implementations

impl MultiSet

pub fn new() -> MultiSet

Creates an empty vector with a multiset wrapper around it

pub fn from_slice(bytes: &[u8]) -> Result<MultiSet, Error>

Generate a MultiSet struct from a slice of bytes.

pub fn to_var_bytes(&self) -> Vec<u8>

Given a MultiSet, return it in it’s bytes representation element by element.

pub fn pad(&mut self, n: u32)

Extends the length of the multiset to n elements The n will be the size of the arithmetic circuit. This will extend the vectors to the size

pub fn push(&mut self, value: BlsScalar)

Pushes chosen value onto the end of the Multiset

pub fn last(&self) -> Option<&BlsScalar>

Fetches last element in MultiSet. Returns None if there are no elements in the MultiSet.

pub fn len(&self) -> usize

Returns the cardinality of the multiset

pub fn is_empty(&self) -> bool

Returns whether or not the multiset is empty.

pub fn position(&self, element: &BlsScalar) -> Option<usize>

Returns the position of the element in the Multiset. Returns None if the element is not found.

pub fn sorted_concat(&self, f: &MultiSet) -> Result<MultiSet, Error>

Concatenates and sorts two Multisets together. From the Plonkup paper, if we have t: {1,2,4,3} and f: {2,3,4,1}. We first check if all elements of f exist in t Then we combine the multisets together and sort their elements together. The final MultiSet will look as follows, s: {1,1,2,2,3,3,4,4}

pub fn contains_all(&self, other: &MultiSet) -> bool

Checks whether one mutltiset is a subset of another. This function will be used to check if the all elements in set f, from the paper, are contained inside t.

pub fn contains(&self, entry: &BlsScalar) -> bool

Checks if an element is in the MultiSet

pub fn halve(&self) -> (MultiSet, MultiSet)

Splits a multiset into halves as specified by the paper The last element of the first half should be the same as the first element of the second half. Since a multiset can never have an even cardinality, we always split it in the way described above.

pub fn halve_alternating(&self) -> (MultiSet, MultiSet)

Splits a multiset into alternating halves of the same length as specified in the Plonkup paper. A multiset must have even cardinality to be split in this manner.

pub fn compress_three_arity(
    multisets: [&MultiSet; 3],
    alpha: BlsScalar
) -> MultiSet

Turn three multisets into a single multiset using a random challenge, Alpha. Alpha is dervived by hashing the transcript. The function iterates over the given sets and mutiplies by alpha: a + (b * alpha) + (c * alpha^2)

pub fn compress_four_arity(
    multisets: [&MultiSet; 4],
    alpha: BlsScalar
) -> MultiSet

Turn four multisets into a single multiset using a random challenge, Alpha. Alpha is dervived by hashing the transcript. The function iterates over the given sets and mutiplies by alpha: a + (b * alpha) + (c * alpha^2) + (d * alpha^3)

Trait Implementations

impl Add<MultiSet> for MultiSet

type Output = MultiSet

The resulting type after applying the + operator.

fn add(self, other: MultiSet) -> Self::Output

Performs the + operation.

impl Clone for MultiSet

fn clone(&self) -> MultiSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiSet

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

Formats the value using the given formatter.

impl Default for MultiSet

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ [Scalar]> for MultiSet

fn from(slice: &[BlsScalar]) -> MultiSet

Performs the conversion.

impl Mul<MultiSet> for MultiSet

type Output = MultiSet

The resulting type after applying the * operator.

fn mul(self, other: MultiSet) -> Self::Output

Performs the * operation.

impl PartialEq<MultiSet> for MultiSet

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

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

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

This method tests for !=.

impl Eq for MultiSet

impl StructuralEq for MultiSet

impl StructuralPartialEq for MultiSet