ark_relations::r1cs

Enum Variable

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

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§

Source§

impl Variable

Source

pub fn is_zero(&self) -> bool

Is self the zero variable?

Source

pub fn is_one(&self) -> bool

Is self the one variable?

Source

pub fn is_instance(&self) -> bool

Is self an instance variable?

Source

pub fn is_witness(&self) -> bool

Is self a witness variable?

Source

pub fn is_lc(&self) -> bool

Is self a linear combination?

Source

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

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

Source

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

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

Trait Implementations§

Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl Clone for Variable

Source§

fn clone(&self) -> Variable

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Variable

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn from(var: Variable) -> Self

Converts to this type from the input type.
Source§

impl Ord for Variable

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Variable

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Variable

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl Copy for Variable

Source§

impl Eq for Variable

Source§

impl StructuralPartialEq for Variable

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more