Struct snarkvm_wasm::Variable

pub struct Variable(_);

Represents a variable in a constraint system.

Implementations

impl Variable

pub fn new_unchecked(idx: Index) -> Variable

This constructs a variable with an arbitrary index. Circuit implementations are not recommended to use this.

pub fn get_unchecked(&self) -> Index

This returns the index underlying the variable. Circuit implementations are not recommended to use this.

pub fn mut_unchecked(&mut self) -> &mut Index

Mutably borrows the index underlying the variable. Circuit implementations are not recommended to use this.

Trait Implementations

impl<F> Add<Variable> for LinearCombination<F> where
    F: Field, 

type Output = LinearCombination<F>

The resulting type after applying the + operator.

pub fn add(self, other: Variable) -> LinearCombination<F>

Performs the + operation.

impl<F> Add<Variable> for ConstraintVariable<F> where
    F: Field, 

type Output = ConstraintVariable<F>

The resulting type after applying the + operator.

pub fn add(self, other: Variable) -> ConstraintVariable<F>

Performs the + operation.

impl Clone for Variable

pub fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Variable

impl Debug for Variable

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

Formats the value using the given formatter.

impl Eq for Variable

impl<F> From<Variable> for LinearCombination<F> where
    F: Field, 

pub fn from(var: Variable) -> LinearCombination<F>

Performs the conversion.

impl<F> From<Variable> for ConstraintVariable<F> where
    F: Field, 

pub fn from(var: Variable) -> ConstraintVariable<F>

Performs the conversion.

impl Hash for Variable

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Variable

pub fn cmp(&self, other: &Variable) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Variable> for Variable

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

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

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

This method tests for !=.

impl PartialOrd<Variable> for Variable

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Variable

impl StructuralPartialEq for Variable

impl<F> Sub<Variable> for ConstraintVariable<F> where
    F: Field, 

type Output = ConstraintVariable<F>

The resulting type after applying the - operator.

pub fn sub(self, other: Variable) -> ConstraintVariable<F>

Performs the - operation.

impl<F> Sub<Variable> for LinearCombination<F> where
    F: Field, 

type Output = LinearCombination<F>

The resulting type after applying the - operator.

pub fn sub(self, other: Variable) -> LinearCombination<F>

Performs the - operation.