Julia API index
Every stable name Julia exports, and its extension seams.
Package: EarthSciASTDiff 0.1.0
Documentation extracted with Base.Docs (Julia 1.13.3).
Extension-tier names are on the Julia extension page .
Stable names
| Julia | Canonical | Kind | Summary |
|---|---|---|---|
assemble_jacobian | assemble_jacobian | function | One-shot convenience over prepare_jacobian: evaluate the analytical Jacobian at a point (defaults: the document’s initial state and parameters). |
Band | band | type | One structured block of ∂(rhs of the equation for u)/∂v: |
BandError | band_error | error | An expression has a form the band calculus cannot differentiate (for example a filtered faq node or a non-"+" semiring). |
BlockDiagonalPlan | block_diagonal_plan | type | Per-cell block factorization info for a :block_diagonal Jacobian (the chemistry shape: every coupling is within-cell, so the global matrix is one identical ns × ns-patterned… |
cse_templates | cse_templates | function | Greedy largest-first extraction of repeated subtrees over exprs. |
DerivativeRuleError | derivative_rule_error | error | A scalar operator has no derivative rule (spec §3). |
detect_structure | detect_structure | function | Classify the Jacobian’s structure from the band list: |
dscalar | dscalar | function | Derivative of the scalar expression e with respect to site s, as a new ESM expression. |
jac_prototype | jac_prototype | function | A freshly zeroed sparse prototype on the structural pattern — the object to pass as ODEFunction(f!; jac_prototype = …). |
JacEntry | jac_entry | type | One band of the model Jacobian: ∂(equation for state u)/∂v`` with its Band. |
jacobian_bands | jacobian_bands | function | Differentiate every differential equation of the system with respect to every state (wrt = :states) or every parameter (wrt = :parameters) that structurally occurs in its… |
jacobian_document | jacobian_document | function | The serialized input document plus the draft "jacobians" top-level block (esm-jacobian-spec.md §4): per model, the differentiation axis, the band entries, the detected… |
jacobian_pattern | jacobian_pattern | function | The structural (global, point-independent) sparsity pattern of the Jacobian as a SparseMatrixCSC{Bool}. |
JacobianEvaluator | jacobian_evaluator | type | Prepared analytical Jacobian: call as jac!(J, u, p, t) where J is (a copy of) jac.prototype. |
lu_fill | lu_fill | function | Symbolic (no-pivoting) LU of a structural pattern: the input pattern plus every fill-in entry Gaussian elimination creates, in natural order. |
ode_components | ode_components | function | Everything a stiff ODE solver needs, with no solver dependency: |
plan_factorization | plan_factorization | function | Symbolic factorization info for the detected structure class, or nothing when no plan is implemented for that class (the Jacobian itself is still fully usable — a plan is an… |
prepare_jacobian | prepare_jacobian | function | Build the analytical Jacobian evaluator once: differentiates the system, compiles the derived band-field model through the ordinary EarthSciAST.build_evaluator, and precomputes… |
scatter_plan | scatter_plan | function | Build the scatter plan of a model’s state Jacobian for layout. |
ScatterPlan | scatter_plan | type | Band fields → storage positions for one (band list, layout). |
simplify_branches | simplify_branches | function | Conditional-specific simplification, complementing EarthSciAST.simplify: |
Site | site | type | The thing a scalar derivative is taken with respect to: a bare VarExpr (scalar variable) or an index(v, i…) node (one symbolic cell of an array variable). |
stable_json | stable_json | function | Deterministic JSON: object keys emitted in sorted order at every level, scalars formatted by JSON3. |
SysView | sys_view | type | Uniform system view: variables (name → ModelVariable), equations, and the document’s index_sets. |
sysview | sysview | function |