Enum kimchi::circuits::expr::ConstantTerm

pub enum ConstantTerm<F> {
    EndoCoefficient,
    Mds {
        row: usize,
        col: usize,
    },
    Literal(F),
}

Define the constant terms an expression can use. It can be any constant term (Literal), a matrix (Mds - used by the permutation used by Poseidon for instance), or endomorphism coefficients (EndoCoefficient - used as an optimisation). As for challengeTerm, it has been used initially to implement the PLONK IOP, with the custom gate Poseidon. However, the terms have no built-in semantic in the expression framework. TODO: we should generalize the expression type over challenges and constants. See https://github.com/MinaProtocol/mina/issues/15287

Variants

EndoCoefficient

Mds

Fields

row: usize

col: usize

Literal(F)

Trait Implementations

impl<F: Clone> Clone for ConstantTerm<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ConstantTerm<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for ConstantTerm<F>where F: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: PrimeField> FormattedOutput for ConstantTerm<F>

fn is_alpha(&self) -> bool

fn ocaml(&self, _cache: &mut HashMap<CacheId, Self>) -> String

fn latex(&self, _cache: &mut HashMap<CacheId, Self>) -> String

fn text(&self, _cache: &mut HashMap<CacheId, Self>) -> String

impl<F, ChallengeTerm> From<ConstantTerm<F>> for ConstantExpr<F, ChallengeTerm>

fn from(x: ConstantTerm<F>) -> Self

Converts to this type from the input type.

impl<F, ChallengeTerm> From<ConstantTerm<F>> for ConstantExprInner<F, ChallengeTerm>

fn from(x: ConstantTerm<F>) -> Self

Converts to this type from the input type.

impl<'a, F, Column, ChallengeTerm: AlphaChallengeTerm<'a>> From<ConstantTerm<F>> for Expr<ConstantExpr<F, ChallengeTerm>, Column>

fn from(x: ConstantTerm<F>) -> Self

Converts to this type from the input type.

impl<F: Clone> Literal for ConstantTerm<F>

type F = F

fn literal(x: Self::F) -> Self

fn to_literal(self) -> Result<Self::F, Self>

fn to_literal_ref(&self) -> Option<&Self::F>

fn as_literal(&self, constants: &Constants<Self::F>) -> Self

Obtains the representation of some constants as a literal. This is useful before converting Kimchi expressions with constants to folding compatible expressions.

impl<F: PartialEq> PartialEq<ConstantTerm<F>> for ConstantTerm<F>

fn eq(&self, other: &ConstantTerm<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> Serialize for ConstantTerm<F>where F: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Copy> Copy for ConstantTerm<F>

impl<F: Eq> Eq for ConstantTerm<F>

impl<F> StructuralEq for ConstantTerm<F>

impl<F> StructuralPartialEq for ConstantTerm<F>