Struct snarkvm_circuit_types::prelude::LinearCombination

pub struct LinearCombination<F>where
    F: PrimeField,{ /* private fields */ }

Implementations

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

pub fn is_constant(&self) -> bool

Returns true if there are no terms in the linear combination.

pub fn is_public(&self) -> bool

Returns true if there is exactly one term with a coefficient of one, and the term contains a public variable.

pub fn is_private(&self) -> bool

Returns true if the linear combination is not constant or public.

pub fn mode(&self) -> Mode

Returns the mode of this linear combination.

pub fn value(&self) -> F

Returns the computed value of the linear combination.

pub fn is_boolean_type(&self) -> bool

Returns true if the linear combination represents a Boolean type, and is well-formed.

Properties:

1. Either constant or terms is utilized, however never both.
2. Every individual variable in the linear combination must always be either 0 or 1.
3. The value of the linear combination must always be either 0 or 1.

Trait Implementations

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

type Output = LinearCombination<F>

The resulting type after applying the + operator.

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

fn add_assign(&mut self, other: &LinearCombination<F>)

Performs the += operation.

impl<F> AddAssign<LinearCombination<F>> for LinearCombination<F>where F: PrimeField,

fn add_assign(&mut self, other: LinearCombination<F>)

Performs the += operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for LinearCombination<F>where F: PrimeField,

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

Formats the value using the given formatter.

impl<F> Display for LinearCombination<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(variables: &[Variable<F>]) -> LinearCombination<F>

Converts to this type from the input type.

impl<F, const N: usize> From<&[Variable<F>; N]> for LinearCombination<F>where F: PrimeField,

fn from(variables: &[Variable<F>; N]) -> LinearCombination<F>

Converts to this type from the input type.

impl<E> From<&Address<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from( address: &Address<E> ) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<&Boolean<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from( boolean: &Boolean<E> ) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<&Field<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(field: &Field<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<&Group<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(group: &Group<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E, I> From<&Integer<E, I>> for LinearCombination<<E as Environment>::BaseField>where E: Environment, I: IntegerType,

fn from( integer: &Integer<E, I> ) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<&LinearCombination<<E as Environment>::BaseField>> for Field<E>where E: Environment,

fn from( linear_combination: &LinearCombination<<E as Environment>::BaseField> ) -> Field<E>

Converts to this type from the input type.

impl<E> From<&Scalar<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(scalar: &Scalar<E>) -> LinearCombination<<E as Environment>::BaseField>

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> From<&Vec<Variable<F>, Global>> for LinearCombination<F>where F: PrimeField,

fn from(variables: &Vec<Variable<F>, Global>) -> LinearCombination<F>

Converts to this type from the input type.

impl<F, const N: usize> From<[Variable<F>; N]> for LinearCombination<F>where F: PrimeField,

fn from(variables: [Variable<F>; N]) -> LinearCombination<F>

Converts to this type from the input type.

impl<E> From<Address<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(address: Address<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<Boolean<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(boolean: Boolean<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<Field<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(field: Field<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<Group<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(group: Group<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E, I> From<Integer<E, I>> for LinearCombination<<E as Environment>::BaseField>where E: Environment, I: IntegerType,

fn from( integer: Integer<E, I> ) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<LinearCombination<<E as Environment>::BaseField>> for Field<E>where E: Environment,

fn from( linear_combination: LinearCombination<<E as Environment>::BaseField> ) -> Field<E>

Converts to this type from the input type.

impl<E> From<Scalar<E>> for LinearCombination<<E as Environment>::BaseField>where E: Environment,

fn from(scalar: Scalar<E>) -> LinearCombination<<E as Environment>::BaseField>

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> From<Vec<Variable<F>, Global>> for LinearCombination<F>where F: PrimeField,

fn from(variables: Vec<Variable<F>, Global>) -> LinearCombination<F>

Converts to this type from the input type.

impl<F> Mul<&F> for &LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the * operator.

fn mul(self, coefficient: &F) -> <&LinearCombination<F> as Mul<&F>>::Output

Performs the * operation.

impl<F> Mul<&F> for LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the * operator.

fn mul(self, coefficient: &F) -> <LinearCombination<F> as Mul<&F>>::Output

Performs the * operation.

impl<F> Mul<F> for &LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the * operator.

fn mul(self, coefficient: F) -> <&LinearCombination<F> as Mul<F>>::Output

Performs the * operation.

impl<F> Mul<F> for LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the * operator.

fn mul(self, coefficient: F) -> <LinearCombination<F> as Mul<F>>::Output

Performs the * operation.

impl<F> Neg for &LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn neg(self) -> <&LinearCombination<F> as Neg>::Output

Performs the unary - operation.

impl<F> Neg for LinearCombination<F>where F: PrimeField,

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn neg(self) -> <LinearCombination<F> as Neg>::Output

Performs the unary - operation.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

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

type Output = LinearCombination<F>

The resulting type after applying the - operator.

fn sub( self, other: LinearCombination<F> ) -> <LinearCombination<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 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.