Enum snarkvm_circuit_environment::helpers::variable::Variable

source ·

pub enum Variable<F: PrimeField> {
    Constant(Rc<F>),
    Public(Index, Rc<F>),
    Private(Index, Rc<F>),
}

Variants

`Constant(Rc<F>)`

`Public(Index, Rc<F>)`

`Private(Index, Rc<F>)`

Implementations

source

impl<F: PrimeField> Variable<F>

source

pub fn is_constant(&self) -> bool

Returns true if the variable is a constant.

source

pub fn is_public(&self) -> bool

Returns true if the variable is public.

source

pub fn is_private(&self) -> bool

Returns true if the variable is private.

source

pub fn mode(&self) -> Mode

Returns the mode of the variable.

source

pub fn index(&self) -> Index

Returns the relative index of the variable.

source

pub fn value(&self) -> F

Returns the value of the variable.

Trait Implementations

source

impl<F: PrimeField> Add<&LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

fn add(self, other: &LinearCombination<F>) -> Self::Output

Performs the + operation. Read more

source

impl<F: PrimeField> Add<&LinearCombination<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

fn add(self, other: &LinearCombination<F>) -> Self::Output

Performs the + operation. Read more

source

impl<F: PrimeField> Add<&Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

fn add(self, other: &Variable<F>) -> Self::Output

Performs the + operation. Read more

source

impl<F: PrimeField> Add<&Variable<F>> for LinearCombination<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

fn add(self, other: &Variable<F>) -> Self::Output

Performs the + operation. Read more

source

impl<F: PrimeField> Add<&Variable<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

fn add(self, other: &Variable<F>) -> Self::Output

Performs the + operation. Read more

source

impl<F: PrimeField> Add<LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl<F: PrimeField> Add<Variable<F>> for &LinearCombination<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl<F: PrimeField> Add<Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl<F: PrimeField> Add<Variable<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl<F: Clone + PrimeField> Clone for Variable<F>

source

fn clone(&self) -> Variable<F>

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<F: PrimeField> Debug for Variable<F>

source

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

Formats the value using the given formatter. Read more

source

impl<F: PrimeField> Display for Variable<F>

source

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

Formats the value using the given formatter. Read more

source

impl<F: PrimeField> From<&Variable<F>> for LinearCombination<F>

source

fn from(variable: &Variable<F>) -> Self

Converts to this type from the input type.

source

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

source

fn from(variable: Variable<F>) -> Self

Converts to this type from the input type.

source

impl<F: Hash + PrimeField> Hash for Variable<F>

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<F: PrimeField> Ord for Variable<F>

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) -> Selfwhere
Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

impl<F: PartialEq + PrimeField> PartialEq<Variable<F>> for Variable<F>

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<F: PrimeField> PartialOrd<Variable<F>> for Variable<F>

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

This method 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

This method 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

This method 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

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

source

impl<F: PrimeField> Sub<&LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

fn sub(self, other: &LinearCombination<F>) -> Self::Output

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<&LinearCombination<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

fn sub(self, other: &LinearCombination<F>) -> Self::Output

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<&Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

fn sub(self, other: &Variable<F>) -> Self::Output

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<&Variable<F>> for LinearCombination<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

fn sub(self, other: &Variable<F>) -> Self::Output

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<&Variable<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

fn sub(self, other: &Variable<F>) -> Self::Output

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<Variable<F>> for &LinearCombination<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl<F: PrimeField> Sub<Variable<F>> for Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl<F: Eq + PrimeField> Eq for Variable<F>

source

impl<F: PrimeField> StructuralEq for Variable<F>

source

impl<F: PrimeField> StructuralPartialEq for Variable<F>

Auto Trait Implementations

impl<F> RefUnwindSafe for Variable<F>where
F: RefUnwindSafe,

impl<F> !Send for Variable<F>

impl<F> !Sync for Variable<F>

impl<F> Unpin for Variable<F>

impl<F> UnwindSafe for Variable<F>where
F: RefUnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

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> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Enum snarkvm_circuit_environment::helpers::variable::Variable

Variants

Constant(Rc<F>)

Public(Index, Rc<F>)

Private(Index, Rc<F>)

Implementations

impl<F: PrimeField> Variable<F>

pub fn is_constant(&self) -> bool

pub fn is_public(&self) -> bool

pub fn is_private(&self) -> bool

pub fn mode(&self) -> Mode

pub fn index(&self) -> Index

pub fn value(&self) -> F

Trait Implementations

impl<F: PrimeField> Add<&LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

fn add(self, other: &LinearCombination<F>) -> Self::Output

impl<F: PrimeField> Add<&LinearCombination<F>> for Variable<F>

type Output = LinearCombination<F>

fn add(self, other: &LinearCombination<F>) -> Self::Output

impl<F: PrimeField> Add<&Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

fn add(self, other: &Variable<F>) -> Self::Output

impl<F: PrimeField> Add<&Variable<F>> for LinearCombination<F>

type Output = LinearCombination<F>

fn add(self, other: &Variable<F>) -> Self::Output

impl<F: PrimeField> Add<&Variable<F>> for Variable<F>

type Output = LinearCombination<F>

fn add(self, other: &Variable<F>) -> Self::Output

impl<F: PrimeField> Add<LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

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

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

type Output = LinearCombination<F>

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

impl<F: PrimeField> Add<Variable<F>> for &LinearCombination<F>

type Output = LinearCombination<F>

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

impl<F: PrimeField> Add<Variable<F>> for &Variable<F>

type Output = LinearCombination<F>

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

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

type Output = LinearCombination<F>

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

impl<F: PrimeField> Add<Variable<F>> for Variable<F>

type Output = LinearCombination<F>

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

impl<F: Clone + PrimeField> Clone for Variable<F>

fn clone(&self) -> Variable<F>

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

impl<F: PrimeField> Debug for Variable<F>

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

impl<F: PrimeField> Display for Variable<F>

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

impl<F: PrimeField> From<&Variable<F>> for LinearCombination<F>

fn from(variable: &Variable<F>) -> Self

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

fn from(variable: Variable<F>) -> Self

impl<F: Hash + PrimeField> Hash for Variable<F>

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

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

impl<F: PrimeField> Ord for Variable<F>

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl<F: PartialEq + PrimeField> PartialEq<Variable<F>> for Variable<F>

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

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

impl<F: PrimeField> PartialOrd<Variable<F>> for Variable<F>

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

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

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

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

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

impl<F: PrimeField> Sub<&LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

fn sub(self, other: &LinearCombination<F>) -> Self::Output

impl<F: PrimeField> Sub<&LinearCombination<F>> for Variable<F>

type Output = LinearCombination<F>

`Constant(Rc<F>)`

`Public(Index, Rc<F>)`

`Private(Index, Rc<F>)`

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

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

impl<F> RefUnwindSafe for Variable<F>where
F: RefUnwindSafe,

impl<F> UnwindSafe for Variable<F>where
F: RefUnwindSafe,

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

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

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

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> ToOwned for Twhere
T: Clone,