Struct Variable 

pub struct Variable(/* private fields */);

Variables in [ConstraintSystem]s

Implementations

impl Variable

pub const Zero: Variable

The zero variable.

pub const One: Variable

The one variable.

pub const fn zero() -> Self

The zero variable.

pub const fn is_zero(&self) -> bool

Is self the zero variable?

pub const fn is_one(&self) -> bool

Is self the one variable?

pub const fn one() -> Self

The one variable.

pub const fn instance(i: usize) -> Self

Construct an instance variable.

pub const fn is_instance(self) -> bool

Is self an instance variable?

pub const fn witness(i: usize) -> Self

Construct a new witness variable.

pub const fn is_witness(self) -> bool

Is self a witness variable?

pub const fn symbolic_lc(i: usize) -> Self

Construct a symbolic linear combination variable.

pub const fn is_lc(self) -> bool

Is self a symbolic linear combination variable?

pub const fn get_lc_index(&self) -> Option<usize>

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

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

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

pub const fn kind(self) -> VarKind

What kind of variable is this?

pub const fn index(self) -> Option<usize>

If self is an instance, witness, or symbolic linear combination, returns the index of that variable.

Trait Implementations

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

type Output = LinearCombination<F>

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 = LinearCombination<F>

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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

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

fn from(var: Variable) -> Self

Converts to this type from the input type.

impl Hash for Variable

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Variable

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Variable

fn eq(&self, other: &Variable) -> 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 PartialOrd for Variable

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

type Output = LinearCombination<F>

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.

impl Copy for Variable

impl Eq for Variable

impl StructuralPartialEq for Variable