Version: dev

convert_units

Stable function · Units

Tier: stable · Kind: function · Topic: Units

JuliaTypeScriptPythonRustGo
not exportedconvertUnitsconvert_unitsconvert_unitsnot exported

Julia

Julia does not export this function.

TypeScript

function convertUnits(value: number, from: string, to: string): number

Convert a numeric value from one unit string to another.

Throws

  • UnitConversionError — when the unit strings have incompatible dimensions or cannot be parsed.

Example

convertUnits(1, 'km', 'm')            // 1000
convertUnits(0, 'Celsius', 'K')       // 273.15
convertUnits(1, 'atm', 'Pa')          // 101325
convertUnits(1, 'Dobson', 'molec/m^2') // 2.6867e20

Source

Python

convert_units(value: float, from_unit: str, to_unit: str) -> UnitConversionResult

Convenience function to convert units.

Parameters

  • value (float) — Numeric value to convert
  • from_unit (str) — Source unit string
  • to_unit (str) — Target unit string

Returns

  • UnitConversionResult — UnitConversionResult with conversion result

Source

Rust

pub fn convert_units(value: f64, from_unit: &Unit, to_unit: &Unit) -> Result<f64, UnitError>

Convert between compatible units

Arguments

  • value - Value to convert
  • from_unit - Source unit
  • to_unit - Target unit

Returns

  • Result<f64, UnitError> - Converted value or error

Source · Rust docs

Example (convert_units)

let km = parse_unit("km")?;
let m = parse_unit("m")?;
assert_eq!(convert_units(2.5, &km, &m)?, 2500.0);

// Incompatible dimensions are an error.
assert!(convert_units(1.0, &km, &parse_unit("s")?).is_err());

From docs/api/examples/rust/units.rs

Go

Go does not export this function.