Skip to main content

SketchSolveResult

Kind: Class
Domain: Sketch
Canonical import: from cadflow import SketchSolveResult

Signature

class SketchSolveResult(sketch_id: 'str', status: 'str', dof: 'int', residual_norm: 'float', iterations: 'int', solved_points: 'Dict[str, Tuple[float, float]]', solved_scalars: 'Dict[str, float]', solved_entities: 'Dict[str, Dict[str, Any]]' = <factory>, diagnostics: 'Tuple[SketchConstraintDiagnostic, ...]' = (), backend: 'str' = 'unknown', backend_version: 'str' = 'unknown', backend_status_code: 'Optional[int]' = None) -> None

Description

Backend-neutral result of solving a declarative sketch.

Other public imports

  • from cadflow.sketch_api import SketchSolveResult

Parameters

NameTypeRequiredDefaultSource description
sketch_id'str'yes-Not explicitly described in the source docstring.
status'str'yes-Not explicitly described in the source docstring.
dof'int'yes-Not explicitly described in the source docstring.
residual_norm'float'yes-Not explicitly described in the source docstring.
iterations'int'yes-Not explicitly described in the source docstring.
solved_points'Dict[str, Tuple[float, float]]'yes-Not explicitly described in the source docstring.
solved_scalars'Dict[str, float]'yes-Not explicitly described in the source docstring.
solved_entities'Dict[str, Dict[str, Any]]'no&lt;factory&gt;Not explicitly described in the source docstring.
diagnostics'Tuple[SketchConstraintDiagnostic, ...]'no()Not explicitly described in the source docstring.
backend'str'no'unknown'Not explicitly described in the source docstring.
backend_version'str'no'unknown'Not explicitly described in the source docstring.
backend_status_code'Optional[int]'noNoneNot explicitly described in the source docstring.

Returns

Type: None

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.

Data fields

NameTypeDefault
sketch_id'str'required
status'str'required
dof'int'required
residual_norm'float'required
iterations'int'required
solved_points'Dict[str, Tuple[float, float]]'required
solved_scalars'Dict[str, float]'required
solved_entities'Dict[str, Dict[str, Any]]'factory
diagnostics'Tuple[SketchConstraintDiagnostic, ...]'()
backend'str''unknown'
backend_version'str''unknown'
backend_status_code'Optional[int]'None

Public members

MemberKindSignatureDescription
to_dictmethod(self) -&gt; 'Dict[str, Any]'See the member signature.

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 SketchSolveResult

See also