broch.core — no.anteo/broch 2024.06.26

* clj/s

(*)

(* x)

(* x y)

(* x y & more)

+ clj/s

(+)

(+ x)

(+ x y)

(+ x y & more)

- clj/s

(- x)

(- x y)

(- x y & more)

/ clj/s

(/ x)

(/ x y)

(/ x y & more)

< clj/s

(< _)

(< x y)

(< x y & more)

<= clj/s

(<= _)

(<= x y)

(<= x y & more)

> clj/s

(> _)

(> x y)

(> x y & more)

>= clj/s

(>= _)

(>= x y)

(>= x y & more)

acres clj/s

amperes clj/s

becquerels clj/s

box clj/s

(box f)

Like boxed but partial.

boxed clj/s

(boxed f x)

Transform the quantity's number by any fn (i.e. fmap on the quantity-functor). Also works for numbers.

Beware:

1. The return value is not checked, and quantities with non-numeric values will cause parts of broch to break.
2. In cljs, broch quantities will sometimes have a ratio number type that is not a regular js Number. These will fail with clojure.core arithmetic ops (+,-,*,/), so use the ops from broch.core instead.

candelas clj/s

centiliters clj/s

centimeters clj/s

compatible-units clj/s

(compatible-units quantity)

Returns units with the same measure as quantity.

composition clj/s

(composition q)

The composition of this quantity.

coulombs clj/s

cubic-centimeters clj/s

cubic-feet clj/s

cubic-inches clj/s

cubic-kilometers clj/s

cubic-meters clj/s

cubic-miles clj/s

cubic-millimeters clj/s

cubic-yards clj/s

deciliters clj/s

decimeters clj/s

defunit clj/s macro

(defunit unit-fn-name measure symb scale-or-comp)

(defunit unit-fn-name measure symb scaling composition)

Can be used to define units, but it's not compatible with cljs. Alternatively use the form this expands to: (def unit-fn-name (new-unit measure symbol scaling composition))

defunit-once clj/s macro

(defunit-once unit-fn-name measure symb scale-or-comp)

(defunit-once unit-fn-name measure symb scaling composition)

Can be used to define units, but it's not compatible with cljs. Alternatively use the form this expands to: (defonce unit-fn-name (new-unit measure symbol scaling composition))

equivalent-quantities clj/s

(equivalent-quantities quantity)

Returns quantities with compatible units equivalent to the given one.

farads clj/s

feet clj/s

from-edn clj/s

(from-edn x)

grams clj/s

grams-per-cubic-centimeter clj/s

grams-per-square-centimeter clj/s

grays clj/s

henrys clj/s

hertz clj/s

hertz-per-second clj/s

hours clj/s

inches clj/s

joules clj/s

katals clj/s

kelvin clj/s

kilograms clj/s

kilograms-per-cubic-meter clj/s

kilograms-per-hour clj/s

kilograms-per-liter clj/s

kilograms-per-second clj/s

kilograms-per-square-centimeter clj/s

kilograms-per-square-meter clj/s

kilometers clj/s

kilometers-per-hour clj/s

kilowatt-hours clj/s

kilowatts clj/s

knots clj/s

liters clj/s

liters-per-hour clj/s

liters-per-second clj/s

long-tons clj/s

lumens clj/s

lux clj/s

max clj/s

(max x)

(max x y)

(max x y & more)

measure clj/s

(measure q)

What this quantity is a measure of.

meters clj/s

meters-per-second clj/s

meters-per-second2 clj/s

micrograms clj/s

micrograms-per-square-millimeter clj/s

microseconds clj/s

miles clj/s

miles-per-hour clj/s

milligrams clj/s

millimeters clj/s

milliseconds clj/s

min clj/s

(min x)

(min x y)

(min x y & more)

minutes clj/s

moles clj/s

nanogram clj/s

nanoseconds clj/s

nautical-miles clj/s

new-unit clj/s

(new-unit measure symb scale-or-comp)

(new-unit measure symb scaling composition)

Register a new type of unit with the given measure, symbol, composition and/or scaling. Returns a fn (fn [number]) that creates a quantity of this unit.

newton-meters clj/s

newtons clj/s

nicest clj/s

(nicest quantity)

(nicest quantity unit-options)

Returns the quantity converted to the "nicest" compatible unit for printing.

"nicest" being defined as the one with the shortest printed number, preferring precise doubles over ratios if available (as ratios can be harder to read).

The 1-arity implementation uses all compatible units as options. This is not recommended for most cases, as broch includes some "weird" units that are often unwanted.

Example: (b/nicest (b/meters 18520)) => #broch/quantity[10 "NM"] ; nautical miles may be unwanted (b/nicest (b/meters 18520) [b/meters b/kilometers]) => #broch/quantity[18.52 "km"]

num clj/s

(num q)

Get the number from a quantity. Pass through if already a number.

ohms clj/s

ounce clj/s

ounces-per-square-inch clj/s

pascals clj/s

picogram clj/s

pounds clj/s

pounds-per-cubic-foot clj/s

pounds-per-square-foot clj/s

pounds-per-square-inch clj/s

quantity clj/s

(quantity unit x)

Makes a new quantity of unit and x.

• unit must be a quantity (but the number part is ignored).
• x must be number-ish, i.e. a number, string of number, or another quantity. If x is a quantity, it will be converted (or throw exception if incompatible).

quantity? clj/s

(quantity? q)

Is this a quantity?

radians clj/s

radians-per-second clj/s

radians-per-second-squared clj/s

seconds clj/s

short-tons clj/s

siemens clj/s

sieverts clj/s

square-centimeters clj/s

square-decimeters clj/s

square-feet clj/s

square-inches clj/s

square-kilometers clj/s

square-meters clj/s

square-miles clj/s

square-millimeters clj/s

square-yards clj/s

steradians clj/s

symbol clj/s

(symbol q)

The unit symbol for this quantity.

tags clj/s

teslas clj/s

to-edn clj/s

(to-edn u)

tonnes clj/s

tonnes-per-hour clj/s

volts clj/s

watt-hours clj/s

watts clj/s

webers clj/s

with-num clj/s

(with-num quantity n)

Make copy of a quantity with a different number.

yards clj/s