measure_constraint_residual
Kind: Function
Domain: Assembly
Canonical import: from cadflow.assembly import measure_constraint_residual
Signature
def measure_constraint_residual(assembly: 'Assembly', constraint_id: 'str') -> 'ConstraintResidual'
Description
Public function in the CadFlow assembly API.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
assembly | 'Assembly' | yes | - | Not explicitly described in the source docstring. |
constraint_id | 'str' | yes | - | Not explicitly described in the source docstring. |
Returns
Type: 'ConstraintResidual'
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.assembly import measure_constraint_residual