monte_carlo_yield¶

Sample a caller-supplied response and summarize its tolerance/yield distribution.

Signature¶

monte_carlo_yield(response: Callable[[dict[str, float]], ArrayLike], nominal: Mapping[str, float], tolerances: Mapping[str, ComponentTolerance], *, sample_count: int=1000, seed: int | None=None, lower_limit: ArrayLike | None=None, upper_limit: ArrayLike | None=None) -> MonteCarloSummary

Parameters¶

Name	Type	Required	Default
`response`	`Callable[[dict[str, float]], ArrayLike]`	yes	-
`nominal`	`Mapping[str, float]`	yes	-
`tolerances`	`Mapping[str, ComponentTolerance]`	yes	-
`sample_count`	`int`	no	`1000`
`seed`	`int \\| None`	no	`None`
`lower_limit`	`ArrayLike \\| None`	no	`None`
`upper_limit`	`ArrayLike \\| None`	no	`None`

Fields¶

Field
`response`
`nominal`
`tolerances`
`sample_count`
`seed`
`lower_limit`
`upper_limit`

Return shape¶

MonteCarloSummary

Permission¶

This is a local SDK helper. It does not call the CloudSprite HTTP API.

Usage¶

cs.monte_carlo_yield(response, nominal, tolerances)