scatter_plan (function)

Stable function · Evaluate the Jacobian

Tier: stable · Kind: function · Topic: Evaluate the Jacobian

Julia	Python	Rust
`scatter_plan`	not exported	not exported

Julia

scatter_plan(input, layout::StorageLayout; model_name)
scatter_plan(entries::Vector{JacEntry}, sv::SysView, layout::StorageLayout)

scatter_plan(input, layout::StorageLayout; model_name = nothing) -> ScatterPlan
scatter_plan(entries, sv::SysView, layout) -> ScatterPlan

Build the scatter plan of a model’s state Jacobian for layout. Throws an ArgumentError naming the reason when the layout does not fit the Jacobian (a stencil under LaneBlocks, a periodic wrap under ColumnBanded, …), and always for an empty band list on a model with array states — that is the silent all-zero Jacobian, never a valid plan.