Miscellaneous API

This page documents various utility functions and constants that don't fit into other categories.

Constants

Missing docstring.

Missing docstring for Symbolics.NAMESPACE_SEPARATOR. Check Documenter's build log for details.

Utility functions

Symbolics.linear_expansion — Function

(a, b, islinear) = linear_expansion(t, x)

When islinear, return a and b such that a * x + b == t. Instead of calling linear_expansion multiple times with the same x, prefer using Symbolics.LinearExpander.

source

Symbolics.LinearExpander — Type

struct LinearExpander

A functor which acts as the workhorse for Symbolics.linear_expansion. The operation linear_expansion(t::Symbolics.SymbolicT, x::Symbolics.SymbolicT) can equivalently be phrased as LinearExpander(x)(t). This functor caches data during processing, and thus several linear_expansion calls with the same x can be rephrased as multiple calls to LinearExpansion(x). This can help avoid repeated computation and allocations.

source

Deprecated

These names are still exported so that existing code keeps working, but each one warns on use and will be removed in the next breaking release.

Symbolics.infimum — Function

Symbolics.infimum(d::AbstractInterval)

Deprecated. Use IntervalSets.infimum (also re-exported by DomainSets) instead.

Return the left endpoint of the interval domain d.

This function was added so that an interval with Num endpoints, such as the domain of a PDE variable written x ∈ Interval(a, b), could be queried for its lower bound. That turned out to be unnecessary: IntervalSets.infimum is generic over the endpoint type and already handles Num, so the only effect of a separate Symbolics.infimum is to shadow it whenever both Symbolics and DomainSets are in scope.

Symbolics.infimum now forwards to IntervalSets.infimum and warns; it will be removed in the next breaking release. Callers should switch to

using DomainSets   # or IntervalSets
infimum(d)

See also: Symbolics.supremum.

source

Symbolics.supremum — Function

Symbolics.supremum(d::AbstractInterval)

Deprecated. Use IntervalSets.supremum (also re-exported by DomainSets) instead.

Return the right endpoint of the interval domain d. This is the counterpart of Symbolics.infimum and is deprecated for the same reason: IntervalSets.supremum is generic over the endpoint type and already handles Num, so a separate Symbolics function only shadows it.

Symbolics.supremum now forwards to IntervalSets.supremum and warns; it will be removed in the next breaking release.

source