Enum ark_relations::r1cs::Variable

pub enum Variable {
    Zero,
    One,
    Instance(usize),
    Witness(usize),
    SymbolicLc(LcIndex),
}

Represents the different kinds of variables present in a constraint system.

Variants

Zero

Represents the “zero” constant.

One

Represents of the “one” constant.

Instance(usize)

Represents a public instance variable.

Witness(usize)

Represents a private witness variable.

SymbolicLc(LcIndex)

Represents of a linear combination.

Implementations

impl Variable

pub fn is_zero(&self) -> bool

Is self the zero variable?

pub fn is_one(&self) -> bool

Is self the one variable?

pub fn is_instance(&self) -> bool

Is self an instance variable?

pub fn is_witness(&self) -> bool

Is self a witness variable?

pub fn is_lc(&self) -> bool

Is self a linear combination?

pub fn get_lc_index(&self) -> Option<LcIndex>

Get the LcIndex in self if self.is_lc().

pub fn get_index_unchecked(&self, witness_offset: usize) -> Option<usize>

Returns Some(usize) if !self.is_lc(), and None otherwise.

Trait Implementations

impl<'a, F: Field> Add<&'a Variable> for LinearCombination<F>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &'a Variable) -> LinearCombination<F>

Performs the + operation.

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Variable

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

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

Formats the value using the given formatter.

impl Eq for Variable

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

fn from(var: Variable) -> Self

Performs the conversion.

impl Ord for Variable

fn cmp(&self, other: &Self) -> 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

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

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

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

This method tests for !=.

impl PartialOrd<Variable> for Variable

fn partial_cmp(&self, other: &Self) -> 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<'a, F: Field> Sub<&'a Variable> for LinearCombination<F>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &'a Variable) -> LinearCombination<F>

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.