@docs Quantity

Unit Systems

The Squared, Cubed, Product and Rate units types allow you to build up and work with composite units in a fairly flexible way.

@docs Squared, Cubed, Product, Rate

Constants

@docs zero, infinity, positiveInfinity, negativeInfinity

Comparison

@docs lessThan, greaterThan, lessThanOrEqualTo, greaterThanOrEqualTo @docs lessThanZero, greaterThanZero, lessThanOrEqualToZero, greaterThanOrEqualToZero @docs compare, equalWithin, max, min, isNaN, isInfinite

Arithmetic

@docs negate, abs, plus, difference, minus, multiplyBy, divideBy, twice, half, ratio, squared, sqrt, cubed, cbrt

Unitless quantities

Some specialized arithmetic functions for working with unitless quantities. squaredUnitless, sqrtUnitless, cubedUnitless and cbrtUnitless all behave just like their non-Unitless versions but return a Unitless result (instead of for example something meaningless like Squared Unitless).

@docs squaredUnitless, sqrtUnitless, cubedUnitless, cbrtUnitless, reciprocal

Working with products

@docs product, times, timesUnitless, over, over_, overUnitless

Working with rates

@docs rate, per, at, at_, for, inverse, rateProduct

Modular arithmetic

modBy and remainderBy behave just like the modBy and remainderBy functions from Elm's built-in Basics module, but work on Quantity values instead of raw Ints. fractionalModBy and fractionalRemainderBy have the same behaviour but extended to Float-valued quantities. import Pixels exposing (pixels) import Length exposing (meters, centimeters) Quantity.modBy (pixels 4) (pixels 11) --> pixels 3 Quantity.fractionalModBy (meters 0.5) (centimeters 162.3) --> centimeters 12.3

@docs modBy, fractionalModBy, remainderBy, fractionalRemainderBy

Miscellaneous

@docs clamp, interpolateFrom, midpoint, range, in_

Int/Float conversion

These functions only really make sense for quantities in units like pixels, cents or game tiles where an Int number of units is meaningful. For quantities like Length or Duration, it doesn't really make sense to round to an Int value since the underyling base unit is pretty arbitrary - should rounding a Duration give you an Int number of seconds, milliseconds, or something else? (The actual behavior is that quantities will generally get rounded to the nearest SI base unit, since that is how they are stored internally - for example, Length values will get rounded to the nearest meter regardless of whether they were constructed from a number of meters, centimeters, inches or light years.)

@docs round, floor, ceiling, truncate, toFloatQuantity

List functions

These functions act just like the corresponding functions in the built-in List module (or, int the case of minimumBy and maximumBy, the List.Extra module from elm-community/list-extra). They're necessary because the built-in List.sum only supports List Int and List Float, and the remaining functions only support built-in comparable types like Int, Float, String and tuples.

@docs sum, minimum, maximum, minimumBy, maximumBy, sort, sortBy

Unitless quantities

It is sometimes useful to be able to represent unitless quantities, especially when working with generic code (in most other cases, it is likely simpler and easier to just use Int or Float values directly). All the conversions in this section simply wrap or unwrap a Float or Int value into a Quantity value, and so should get compiled away entirely when using elm make --optimize.

@docs Unitless, int, toInt, float, toFloat

Unsafe conversions

These functions are equivalent to directly constructing or unwrapping Quantity values, and generally shouldn't be used outside of some specialized situations that can come up when authoring packages that use elm-units. @docs unsafe, unwrap

Operators