check_tolerance
Kind: Function
Domain: Expressions, units, and tolerances
Canonical import: from cadflow import check_tolerance
Signature
def check_tolerance(value: 'ScalarLike', tolerance: 'ToleranceLike', *, method: 'ToleranceMethod' = 'worst_case', name: 'str | None' = None, tolerance_unit: 'UnitLike | None' = None) -> 'ToleranceCheck'
Description
Propagate and verify one Length or Angle requirement.
Propagate and verify one Length or Angle requirement.
tolerance_unit defaults to the target dimension's canonical unit. When provided, it must be dimensionally compatible and is converted before the comparison. Legacy unitless requirements remain supported when no unit is supplied.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
value | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
tolerance | 'ToleranceLike' | yes | - | Not explicitly described in the source docstring. |
method | 'ToleranceMethod' | no | 'worst_case' | Not explicitly described in the source docstring. |
name | 'str | None' | no | None | Not explicitly described in the source docstring. |
tolerance_unit | 'UnitLike | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'ToleranceCheck'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import check_tolerance