stripped_constructs

Stable type · Other

Tier: stable · Kind: type · Topic: Other

Julia	TypeScript	Python	Rust	Go
`StrippedConstructs`	not exported	`StrippedConstructs`	`StrippedConstructs`	not exported

Julia

struct StrippedConstructs
StrippedConstructs(strip::Vector{String}, events::Vector{Any}, parameter_updates::Vector{Any}, z_layout::Vector{Any}, z0::Vector{Union{Nothing, Float64}}, residuals::Vector{Any})
StrippedConstructs(strip, events, parameter_updates, z_layout, z0, residuals)

StrippedConstructs

What esm_problem(…; strip) removed (API_SPEC §5.8, “The stripped object”): the events, the stripped parameter updates, the residuals of the implicit equations, and the z layout with its starting values. Read it with stripped ; canonical_json gives its canonical JSON.

Source

TypeScript

TypeScript does not export this type.

Python

class StrippedConstructs
StrippedConstructs(strip: list[str] = list(), events: list[dict[str, Any]] = list(), parameter_updates: list[dict[str, Any]] = list(), unknowns: list[str] = list(), z_layout: dict[str, dict[str, Any]] = dict(), z0: list[float | None] = list(), residuals: list[dict[str, Any]] = list())
StrippedConstructs.is_empty() -> bool
StrippedConstructs.removed_classes() -> list[str]
StrippedConstructs.to_json() -> dict[str, Any]
StrippedConstructs.canonical_json() -> str

What strip removed (API_SPEC §5.8, “The stripped object”).

Members

canonical_json — Compact, keys ascending, numbers in CONFORMANCE_SPEC §5.5.3.1 form.

Source

Rust

pub struct StrippedConstructs {
    /* private fields */
}

impl StrippedConstructs { pub fn strip(&self) -> StripSet }

impl StrippedConstructs { pub fn events(&self) -> &[StrippedEvent] }

impl StrippedConstructs { pub fn parameter_updates(&self) -> &[StrippedUpdate] }

impl StrippedConstructs { pub fn algebraic_unknowns(&self) -> Vec<&str> }

impl StrippedConstructs { pub fn z_layout(&self) -> &[ZBlock] }

impl StrippedConstructs { pub fn n_z(&self) -> usize }

impl StrippedConstructs { pub fn z0(&self) -> &[Option<f64>] }

impl StrippedConstructs { pub fn residuals(&self) -> &[StrippedResidual] }

impl StrippedConstructs { pub fn is_empty(&self) -> bool }

impl StrippedConstructs { pub fn removed_classes(&self) -> Vec<&'static str> }

impl StrippedConstructs { pub fn to_json(&self) -> Value }

impl StrippedConstructs { pub fn canonical_json(&self) -> String }

What strip removed (API_SPEC §5.8, “The stripped object”). Empty when nothing was requested or nothing was found.

Source · Rust docs

Go does not export this type.