Enum snarkvm_circuit_environment::helpers::variable::Variable

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

impl<F: PrimeField> Variable<F>

pub fn is_constant(&self) -> bool

Returns true if the variable is a constant.

pub fn is_public(&self) -> bool

Returns true if the variable is public.

pub fn is_private(&self) -> bool

Returns true if the variable is private.

pub fn mode(&self) -> Mode

Returns the mode of the variable.

pub fn index(&self) -> Index

Returns the relative index of the variable.

pub fn value(&self) -> F

Returns the value of the variable.

Trait Implementations

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Converts a variable to an assignment variable.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

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.

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

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

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

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

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

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

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

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

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

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<F: PrimeField> Sub<&LinearCombination<F>> for &Variable<F>

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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