Julia API index
Every stable name Julia exports, and its extension seams.
Package: EarthSciASTDiff 0.2.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 |
|---|---|---|---|
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). |
bind_plan | bind_plan | function | Check plan against the state Jacobian of input (an EsmFile or a FlattenedSystem) and precompute its gather. |
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… |
column_lines | column_lines | function | The per-line structure of a state Jacobian whose couplings all stay within one line along index set axis, or nothing when one does not: every band couples two array states of… |
ColumnBlockPlan | column_block_plan | type | Line-by-line factorization info for a :column_block Jacobian: every coupling stays within one line along axis, so the matrix is one (length(block_vars)·line_length)-square… |
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. |
evaluation_document | evaluation_document | function | The derived evaluation document of the first-order bands on axis wrt (esm-jacobian-spec.md §8, model "JacobianEval"): the source’s observed the coefficients read, every… |
forcing_names | forcing_names | function | The forcing set of a system, sorted by name: the parameters whose cells are the columns of the wrt = :forcing axis (esm-jacobian-spec.md §4.3). |
hvp_document | hvp_document | function | The second-order product document of esm-jacobian-spec.md §9.4 for the axis pair wrt and stages stage pairs: its right-hand side leaves g = ∇_{a2} Σᵢ μᵢᵀ J(u) wᵢ (`∇_{a2}… |
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. |
JacEntry2 | jac_entry2 | type | One second-order band: ∂²(equation for u)/∂v ∂w. |
jacobian_bands | jacobian_bands | function | Differentiate every differential equation of the system with respect to every state (wrt = :states), every parameter outside the forcing set (wrt = :parameters, scalar and… |
jacobian_bands2 | jacobian_bands2 | function | Second-order bands for the axis pair wrt = (a1, a2), a1 ∈ (:states, :time) and a2 ∈ (:states, :parameters, :forcing): every first-order entry of the a1 axis… |
jacobian_columns | jacobian_columns | function | The column space of a :parameters or :forcing block: each column variable with its integer shape (Int[] for a scalar), sorted by name — the columns field of the emitted… |
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, and — on the state… |
jacobian_pattern | jacobian_pattern | function | The structural (global, point-independent) sparsity pattern of the Jacobian as a SparseMatrixCSC{Bool}. |
jvp_document | jvp_document | function | The product documents of esm-jacobian-spec.md §9.2 / §9.3 for one first-order axis: a derived ESM document (model "JvpEval" / "VjpEval") whose right-hand side, evaluated by… |
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. |
parse_jacobian_blocks | parse_jacobian_blocks | function | parse_jacobian_block over a model’s "jacobians" entry, which is either one block or an array of blocks with distinct wrt (esm-jacobian-spec.md §4); returns one `(wrt,… |
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… |
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). |
serialize_plan | serialize_plan | function | Serialize a plan into the "factorization" field of the document block. |
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 | |
vjp_document | vjp_document | function | The product documents of esm-jacobian-spec.md §9.2 / §9.3 for one first-order axis: a derived ESM document (model "JvpEval" / "VjpEval") whose right-hand side, evaluated by… |