snarkvm_circuit_environment::helpers::linear_combination

Struct LinearCombination

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

Implementations§

Source§

impl<F: PrimeField> LinearCombination<F>

Source

pub fn is_constant(&self) -> bool

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

Source

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.

Source

pub fn is_private(&self) -> bool

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

Source

pub fn mode(&self) -> Mode

Returns the mode of this linear combination.

Source

pub fn value(&self) -> F

Returns the computed value of the linear combination.

Source

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§

Source§

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

Source§

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>

Source§

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 LinearCombination<F>

Source§

type Output = LinearCombination<F>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

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>

Source§

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 &LinearCombination<F>

Source§

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>

Source§

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>

Source§

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>

Source§

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>

Source§

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 for LinearCombination<F>

Source§

type Output = LinearCombination<F>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl<F: PrimeField> AddAssign<&LinearCombination<F>> for LinearCombination<F>

Source§

fn add_assign(&mut self, other: &Self)

Performs the += operation. Read more
Source§

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

Source§

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more
Source§

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

Source§

fn clone(&self) -> LinearCombination<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 LinearCombination<F>

Source§

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

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

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

Source§

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

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

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

Source§

fn from(variables: &[Variable<F>]) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(lc: &LinearCombination<F>) -> Self

Converts a linear combination to an assignment linear combination.

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<&Vec<Variable<F>>> for LinearCombination<F>

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(variables: [Variable<F>; N]) -> 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: PrimeField> From<Vec<Variable<F>>> for LinearCombination<F>

Source§

fn from(variables: Vec<Variable<F>>) -> Self

Converts to this type from the input type.
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the * operator.
Source§

fn mul(self, coefficient: &F) -> Self::Output

Performs the * operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the * operator.
Source§

fn mul(self, coefficient: &F) -> Self::Output

Performs the * operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the * operator.
Source§

fn mul(self, coefficient: F) -> Self::Output

Performs the * operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the * operator.
Source§

fn mul(self, coefficient: F) -> Self::Output

Performs the * operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

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

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

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

Source§

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>

Source§

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 LinearCombination<F>

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

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>

Source§

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 &LinearCombination<F>

Source§

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>

Source§

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>

Source§

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>

Source§

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>

Source§

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 for LinearCombination<F>

Source§

type Output = LinearCombination<F>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more

Auto Trait Implementations§

§

impl<F> Freeze for LinearCombination<F>
where F: Freeze,

§

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

§

impl<F> !Send for LinearCombination<F>

§

impl<F> !Sync for LinearCombination<F>

§

impl<F> Unpin for LinearCombination<F>
where F: Unpin,

§

impl<F> UnwindSafe for LinearCombination<F>
where F: UnwindSafe + RefUnwindSafe,

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

🔬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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> ToSmolStr for T
where T: Display + ?Sized,

Source§

fn to_smolstr(&self) -> SmolStr

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. 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