Enum snarkvm_circuit::Variable

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

Variants

Constant(Rc<F>)

Public(u64, Rc<F>)

Private(u64, Rc<F>)

Implementations

impl<F> Variable<F>where
    F: PrimeField,

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) -> u64

Returns the relative index of the variable.

pub fn value(&self) -> F

Returns the value of the variable.

Trait Implementations

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

fn add(
    self,
    other: &LinearCombination<F>
) -> <&Variable<F> as Add<&LinearCombination<F>>>::Output

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

fn add(
    self,
    other: &LinearCombination<F>
) -> <Variable<F> as Add<&LinearCombination<F>>>::Output

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

fn add(
    self,
    other: &Variable<F>
) -> <LinearCombination<F> as Add<&Variable<F>>>::Output

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

fn add(
    self,
    other: LinearCombination<F>
) -> <&Variable<F> as Add<LinearCombination<F>>>::Output

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

fn add(
    self,
    other: Variable<F>
) -> <&LinearCombination<F> as Add<Variable<F>>>::Output

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

fn cmp(&self, other: &Variable<F>) -> 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<Variable<F>> for Variable<F>where
    F: PartialEq<F> + PrimeField,

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> PartialOrd<Variable<F>> for Variable<F>where
    F: PrimeField,

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub(
    self,
    other: &LinearCombination<F>
) -> <&Variable<F> as Sub<&LinearCombination<F>>>::Output

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub(
    self,
    other: &LinearCombination<F>
) -> <Variable<F> as Sub<&LinearCombination<F>>>::Output

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub(
    self,
    other: &Variable<F>
) -> <LinearCombination<F> as Sub<&Variable<F>>>::Output

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub(
    self,
    other: LinearCombination<F>
) -> <&Variable<F> as Sub<LinearCombination<F>>>::Output

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub(
    self,
    other: Variable<F>
) -> <&LinearCombination<F> as Sub<Variable<F>>>::Output

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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