Skip to main content

convert_value

Kind: Function
Domain: Expressions, units, and tolerances
Canonical import: from cadflow import convert_value

Signature

def convert_value(value: 'int | float', from_unit: 'UnitLike', to_unit: 'UnitLike') -> 'float'

Description

Convert a finite numeric value between dimensionally compatible units.

Parameters

NameTypeRequiredDefaultSource description
value'int | float'yes-Not explicitly described in the source docstring.
from_unit'UnitLike'yes-Not explicitly described in the source docstring.
to_unit'UnitLike'yes-Not explicitly described in the source docstring.

Returns

Type: 'float'

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 convert_value

See also