units

Labs

Description

Runtime support module for quantities and units.

Based on mp-units library licensed under MIT.

Warning

Work in progress, features are missing and are subject to changes.

Index

Submodules

iec

IEC declarations

imperial

Imperial units declarations.

isq

ISQ declarations

si

SI declarations

typographic

Typographic units declarations.

usc

United States customary units declarations.

yard_pound

International yard and pound units declarations.

Classes

BaseDimension

A simple wrapper for a short-named base dimension.

Delta

A marker type for tagging any type as producing a delta quantity.

Kind

A kind of specification.

Point

A marker type for tagging any type as producing a quantity point.

PointOrigin

Marker type for quantity origins.

Prefix

A unit prefix.

PrefixableUnit

A unit that can be prefixed.

Quantity

A concrete absolute quantity value.

QuantityDelta

A concrete quantity delta value.

QuantityPoint

A concrete quantity point value.

Specification

Structure containing dimensions of a unit or quantity.

Unit

A concrete amount of quantity to measure the values of quantities of the same kind.

Attributes

Tcov

R

Functions

delta

Convenience function to create a QuantityDelta.

point

Convenience function to create a QuantityPoint relative to the natural zero.

Enumerations

Convertible

Level of convertibility between quantities.


Attributes

Tcov = TypeVar("Tcov", covariant=True)

Functions

delta(arg0: float, arg1: syside.experimental.units.Unit, /) → syside.experimental.units.QuantityDelta

Convenience function to create a QuantityDelta.

point(arg0: float, arg1: syside.experimental.units.Unit, /) → syside.experimental.units.QuantityPoint

Convenience function to create a QuantityPoint relative to the natural zero.

Enumerations

class Convertible

Level of convertibility between quantities.

Quantities are not interconvertible.

For example, time and mass.

Quantities require casting between different branches of the same kind.

For example, width and height.

Quantities require explicit conversion across different kinds. Expect this to be removed in the future.

For example, solid_angular_measure and angular_measure.

Quantity to be converted requires an explicit conversion, i.e. a downcast.

For example, length to width.

Quantity is implicitly convertible to another quantity.

For example, width to length.