Struct CoreSubstitution

pub struct CoreSubstitution<L: Language> { /* private fields */ }

Implementations

impl<L: Language> CoreSubstitution<L>

pub fn domain(&self) -> Set<CoreVariable<L>>

Returns the variables that will be substituted for a new value.

pub fn range(&self) -> Set<CoreParameter<L>>

Returns the parameters that that will be substituted for a new value.

pub fn maps(&self, v: CoreVariable<L>) -> bool

True if v is in this substitution’s domain

pub fn iter( &self, ) -> impl Iterator<Item = (CoreVariable<L>, CoreParameter<L>)> + '_

pub fn is_empty(&self) -> bool

An empty substitution is just the identity function.

impl<L: Language> CoreSubstitution<L>

pub fn apply<T: CoreFold<L>>(&self, t: &T) -> T

pub fn get(&self, v: CoreVariable<L>) -> Option<CoreParameter<L>>

Trait Implementations

impl<L: Clone + Language> Clone for CoreSubstitution<L>

fn clone(&self) -> CoreSubstitution<L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L: Language> CoreFold<L> for CoreSubstitution<L>

fn substitute(&self, substitution_fn: SubstitutionFn<'_, L>) -> Self

Replace uses of variables with values from the substitution.

fn shift_in(&self) -> Self

Produce a version of this term where any debruijn indices which appear free are incremented by one.

fn replace_free_var( &self, v: impl Upcast<CoreVariable<L>>, p: impl Upcast<CoreParameter<L>>, ) -> Self

Replace all appearances of free variable v with p.

impl<L: Language> CoreVisit<L> for CoreSubstitution<L>

fn free_variables(&self) -> Vec<CoreVariable<L>>

Extract the list of free variables (for the purposes of this function, defined by Variable::is_free). The list may contain duplicates and must be in a determinstic order (though the order itself isn’t important).

fn size(&self) -> usize

Measures the overall size of the term by counting constructors etc. Used to determine overflow.

fn assert_valid(&self)

Asserts various validity constraints and panics if they are not held. These validition constraints should never fail unless there is a bug in our logic. This is to aid with fuzzing and bug detection.

fn references_only_universal_variables(&self) -> bool

True if this term references only universal variables. This means that it contains no existential variables. If this is a goal, then when we prove it true, we don’t expect any substitution. This is similar, but not identical, to the commonly used term “ground term”, which in Prolog refers to a term that contains no variables. The difference here is that the term may contain variables, but only those instantiated universally (∀).

impl<L: Language> Debug for CoreSubstitution<L>

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

Formats the value using the given formatter.

impl<L: Default + Language> Default for CoreSubstitution<L>

fn default() -> CoreSubstitution<L>

Returns the “default value” for a type.

impl<L: Language, A, B> Extend<(A, B)> for CoreSubstitution<L>

where A: Upcast<CoreVariable<L>>, B: Upcast<CoreParameter<L>>,

fn extend<T: IntoIterator<Item = (A, B)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<L: Language, A, B> FromIterator<(A, B)> for CoreSubstitution<L>

where A: Upcast<CoreVariable<L>>, B: Upcast<CoreParameter<L>>,

fn from_iter<T: IntoIterator<Item = (A, B)>>(iter: T) -> Self

Creates a value from an iterator.

impl<L: Hash + Language> Hash for CoreSubstitution<L>

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<L: Language> Index<CoreVariable<L>> for CoreSubstitution<L>

type Output = <L as Language>::Parameter

The returned type after indexing.

fn index(&self, index: CoreVariable<L>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<L: Language> IntoIterator for CoreSubstitution<L>

type Item = (CoreVariable<L>, <L as Language>::Parameter)

The type of the elements being iterated over.

type IntoIter = IntoIter<CoreVariable<L>, <L as Language>::Parameter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<L: Ord + Language> Ord for CoreSubstitution<L>

fn cmp(&self, other: &CoreSubstitution<L>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<L: PartialEq + Language> PartialEq for CoreSubstitution<L>

fn eq(&self, other: &CoreSubstitution<L>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<L: PartialOrd + Language> PartialOrd for CoreSubstitution<L>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<L: Language, Vs> SubAssign<Vs> for CoreSubstitution<L>

where Vs: Upcast<Vec<CoreVariable<L>>>,

fn sub_assign(&mut self, rhs: Vs)

Performs the -= operation.

impl<L: Language, A, B> UpcastFrom<(A, B)> for CoreSubstitution<L>

where A: Upcast<CoreVariable<L>>, B: Upcast<CoreParameter<L>>,

fn upcast_from(term: (A, B)) -> Self

impl<L: Eq + Language> Eq for CoreSubstitution<L>

impl<L: Language> StructuralPartialEq for CoreSubstitution<L>