This is the physical-quantities Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:33:52 2024 GMT+0.
physical-quantities/physical-quantities.asdphysical-quantities/package.lispphysical-quantities/utils.lispphysical-quantities/conditions.lispphysical-quantities/unit-factor.lispphysical-quantities/unit-database.lispphysical-quantities/units.lispphysical-quantities/quantity.lispphysical-quantities/numeric.lispphysical-quantities/parse-rules.lispphysical-quantities/read-macro.lispphysical-quantities/si-units.lispThe main system appears first, followed by any subsystem dependency.
physical-quantitiesA library that provides a numeric type with optional unit and/or uncertainty for computations with automatic error propagation.
Marco Rossini
GPLv2
0.1
parseq (system).
package.lisp (file).
utils.lisp (file).
conditions.lisp (file).
unit-factor.lisp (file).
unit-database.lisp (file).
units.lisp (file).
quantity.lisp (file).
numeric.lisp (file).
parse-rules.lisp (file).
read-macro.lisp (file).
si-units.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
physical-quantities/physical-quantities.asdphysical-quantities/package.lispphysical-quantities/utils.lispphysical-quantities/conditions.lispphysical-quantities/unit-factor.lispphysical-quantities/unit-database.lispphysical-quantities/units.lispphysical-quantities/quantity.lispphysical-quantities/numeric.lispphysical-quantities/parse-rules.lispphysical-quantities/read-macro.lispphysical-quantities/si-units.lispphysical-quantities/physical-quantities.asdphysical-quantities (system).
physical-quantities/package.lispphysical-quantities (system).
physical-quantities/utils.lisppackage.lisp (file).
physical-quantities (system).
beta (function).
chebyshev-polynomial (function).
chebyshev-polynomial% (function).
confidence-interval (function).
copy-hash-table (function).
erf (function).
has-key (function).
have (function).
inverf (function).
l= (function).
l> (function).
ll= (function).
mklist (function).
mkstr (function).
nand (macro).
p-value (function).
py+ (function).
quantile (function).
r-function-a (function).
r-function-b (function).
split (function).
symb (function).
unzip (function).
with-gensyms (macro).
xnor (function).
physical-quantities/conditions.lisputils.lisp (file).
physical-quantities (system).
error-propagation-error (condition).
invalid-unit-conversion-error (condition).
invalid-unit-error (condition).
invalid-unit-operation-error (condition).
invalid-unit-reference-error (condition).
operation-undefined-error (condition).
physical-quantities-error (condition).
unit-definition-conflict-error (condition).
unit-definition-error (condition).
unit-definition-semantic-error (condition).
unit-definition-syntax-error (condition).
f-error (macro).
quantity-definition-error (condition).
quantity-definition-semantic-error (condition).
quantity-definition-syntax-error (condition).
physical-quantities/unit-factor.lispconditions.lisp (file).
physical-quantities (system).
uf-power (reader).
(setf uf-power) (writer).
uf-unit (reader).
(setf uf-unit) (writer).
copy-unit-factor (function).
make-uf (function).
uf-equal (function).
uf-pow (function).
unit-factor (structure).
unit-factor-p (function).
physical-quantities/unit-database.lispunit-factor.lisp (file).
physical-quantities (system).
define-unit (macro).
define-unit-prefix (macro).
with-local-units (macro).
with-saved-units (macro).
*unit-abbreviation-table* (special variable).
*unit-alias-table* (special variable).
*unit-prefix-table* (special variable).
*unit-translation-table* (special variable).
clear-units (function).
define-unit% (function).
define-unit-prefix% (function).
lookup-unit (function).
prefix-and (function).
prefix-base (function).
prefix-list (function).
prefix-or (function).
prefix-range (function).
symbol-prefix (function).
table-check (function).
table-insert (function).
unit-hash-key-check (function).
with-unit-lookup (macro).
physical-quantities/units.lispunit-database.lisp (file).
physical-quantities (system).
make-unit (function).
mkunit (macro).
str-unit (function).
unitp (function).
units-convertible (function).
units-equal (function).
units-equalp (function).
collect-factors (function).
convert-unit% (function).
copy-unit (function).
dereference-unit (function).
divide-units (function).
expand-unit (function).
expand-unit-factor (function).
multiply-units (function).
power-unit (function).
reduce-unit (function).
root-unit (function).
sort-unit (function).
unit-has-unit-p (function).
physical-quantities/quantity.lispunits.lisp (file).
physical-quantities (system).
absolute-error (generic function).
(setf absolute-error) (generic function).
convert-to-base-units (function).
convert-unit (function).
make-quantity (function).
print-object (method).
quantity (macro).
quantity (class).
quantityp (function).
relative-error (generic function).
(setf relative-error) (generic function).
unit (reader method).
(setf unit) (writer method).
value (reader method).
(setf value) (writer method).
ae (function).
error-direct (reader method).
(setf error-direct) (writer method).
errorlessp (function).
eval-quantity (generic function).
has-error-p (function).
has-unit-p (function).
make-quantity% (function).
re (function).
unitlessp (function).
physical-quantities/numeric.lispquantity.lisp (file).
physical-quantities (system).
defqop (macro).
q* (function).
q+ (function).
q- (function).
q/ (function).
q/= (function).
q< (generic function).
q<= (generic function).
q= (generic function).
q> (generic function).
q>= (generic function).
qabs (function).
qacos (function).
qacosh (function).
qasin (function).
qasinh (function).
qatan (function).
qatanh (function).
qcos (function).
qcosh (function).
qequal (function).
qequalp (function).
qexp (function).
qexpt (function).
qln (function).
qlog (function).
qop (macro).
qpow (function).
qroot (function).
qround (function).
qsin (function).
qsinh (function).
qsqrt (function).
qtan (function).
qtanh (function).
dup-quantity (macro).
error-propagation (macro).
q-op-insert (function).
round-to (function).
physical-quantities/parse-rules.lispnumeric.lisp (file).
physical-quantities (system).
physical-quantities/read-macro.lispparse-rules.lisp (file).
physical-quantities (system).
define-read-macros (function).
read-quantity (function).
read-unit (function).
physical-quantities/si-units.lispread-macro.lisp (file).
physical-quantities (system).
define-si-units (function).
Packages are listed by definition order.
physical-quantitiesphysq
pquant
pq
common-lisp.
parseq.
absolute-error (generic function).
(setf absolute-error) (generic function).
aerr (generic function).
(setf aerr) (generic function).
convert-to-base-units (function).
convert-unit (function).
define-read-macros (function).
define-si-units (function).
define-unit (macro).
define-unit-prefix (macro).
defqop (macro).
error-propagation-error (condition).
invalid-unit-conversion-error (condition).
invalid-unit-error (condition).
invalid-unit-operation-error (condition).
invalid-unit-reference-error (condition).
make-quantity (function).
make-unit (function).
mkunit (macro).
operation-undefined-error (condition).
physical-quantities-error (condition).
q* (function).
q+ (function).
q- (function).
q/ (function).
q/= (function).
q< (generic function).
q<= (generic function).
q= (generic function).
q> (generic function).
q>= (generic function).
qabs (function).
qacos (function).
qacosh (function).
qasin (function).
qasinh (function).
qatan (function).
qatanh (function).
qcos (function).
qcosh (function).
qequal (function).
qequalp (function).
qexp (function).
qexpt (function).
qln (function).
qlog (function).
qop (macro).
qpow (function).
qroot (function).
qround (function).
qsin (function).
qsinh (function).
qsqrt (function).
qtan (function).
qtanh (function).
quantity (macro).
quantity (class).
quantityp (function).
relative-error (generic function).
(setf relative-error) (generic function).
rerr (generic function).
(setf rerr) (generic function).
str-unit (function).
uf-power (reader).
(setf uf-power) (writer).
uf-unit (reader).
(setf uf-unit) (writer).
unit (generic reader).
(setf unit) (generic writer).
unit-definition-conflict-error (condition).
unit-definition-error (condition).
unit-definition-semantic-error (condition).
unit-definition-syntax-error (condition).
unitp (function).
units-convertible (function).
units-equal (function).
units-equalp (function).
value (generic reader).
(setf value) (generic writer).
with-local-units (macro).
with-saved-units (macro).
*unit-abbreviation-table* (special variable).
*unit-alias-table* (special variable).
*unit-prefix-table* (special variable).
*unit-translation-table* (special variable).
ae (function).
beta (function).
chebyshev-polynomial (function).
chebyshev-polynomial% (function).
clear-units (function).
collect-factors (function).
confidence-interval (function).
convert-unit% (function).
copy-hash-table (function).
copy-unit (function).
copy-unit-factor (function).
define-unit% (function).
define-unit-prefix% (function).
dereference-unit (function).
divide-units (function).
dup-quantity (macro).
erf (function).
error-direct (generic reader).
(setf error-direct) (generic writer).
error-propagation (macro).
errorlessp (function).
eval-quantity (generic function).
expand-unit (function).
expand-unit-factor (function).
f-error (macro).
has-error-p (function).
has-key (function).
has-unit-p (function).
have (function).
inverf (function).
l= (function).
l> (function).
ll= (function).
lookup-unit (function).
make-quantity% (function).
make-uf (function).
mklist (function).
mkstr (function).
multiply-units (function).
nand (macro).
p-value (function).
power-unit (function).
prefix-and (function).
prefix-base (function).
prefix-list (function).
prefix-or (function).
prefix-range (function).
py+ (function).
q-op-insert (function).
quantile (function).
quantity-definition-error (condition).
quantity-definition-semantic-error (condition).
quantity-definition-syntax-error (condition).
r-function-a (function).
r-function-b (function).
re (function).
read-quantity (function).
read-unit (function).
reduce-unit (function).
root-unit (function).
round-to (function).
sort-unit (function).
split (function).
symb (function).
symbol-prefix (function).
table-check (function).
table-insert (function).
uf-equal (function).
uf-pow (function).
unit-factor (structure).
unit-factor-p (function).
unit-has-unit-p (function).
unit-hash-key-check (function).
unitlessp (function).
unzip (function).
with-gensyms (macro).
with-unit-lookup (macro).
xnor (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Human interface to make a unit.
Function to define quantities without the reader macro.
Shadow the global unit table with a new rule table.
Shadow the global unit table with a copy of the unit table. When returninng from the body the original units are restored.
Lets the user define the #q(...) and #u(...) read macros.
Machine interface for making a unit.
Computes the square root of a given quantity. Result must always be real.
Prints the given unit in human readable form
Checks whether an object is a unit.
Expands and reduces both units and compares the unit factors for equality (in unit and power)
Reduces both units (without converting to base units) and compares the unit factors for equality (in unit and power)
Reduces both units (converting to base units) and compares the unit factors for equality (in unit and power)
Determines whether the one quantity is less than another quantity
real) (y real) &optional p-value) ¶Determines whether the one quantity is less or equal to another quantity
real) (y real) &optional p-value) ¶Determines whether the value of two quantities are equal.
real) (y real) &optional p-value) ¶Determines whether the one quantity is greater than another quantity
real) (y real) &optional p-value) ¶Determines whether the one quantity is greater or equal to another quantity
real) (y real) &optional p-value) ¶Error for situations in which the propagation of uncertainty is undefined
Error when converting between incompatible units
Generic unit error
Error for situations in which the unit is invalid in a given operation
Unit lookup error
Error for situations in which an operation is undefined
Generic error for the physical quantities library.
simple-error.
Name conflict for the definition of a unit/prefix
Generic error for unit/prefix definitions.
Semantic error in the definition of a unit/prefix
Syntax error in the definition of a unit/prefix
(setf absolute-error).
absolute-error.
(setf error-direct).
error-direct.
eval-quantity.
eval-quantity.
eval-quantity.
print-object.
q<.
q<.
q<.
q<=.
q<=.
q<=.
q=.
q=.
q=.
q>.
q>.
q>.
q>=.
q>=.
q>=.
(setf relative-error).
relative-error.
(setf unit).
unit.
(setf value).
value.
0
:value
common-lisp.
0
:error
Like (error ...), but allows the condition type to be specified (which is required to inherit from simple-condition).
Helper for the inverf function.
Evaluates the nth Chebyshev polynomial.
Recursion function for the Chebyshev polynomial evaluation.
Applies the conversion factor between unit-a and unit-b to the given value.
Creates a copy of the given hash table.
Creates a copy of the given unit.
Defines a new unit with the identifier name. A list of aliases and a list of abbreviations are permitted which - when encountered - are internally converted to the primary identifier. The definition allows the unit to be defined in terms of other units, e.g :def (1.602 kilometre). Prefixes is must be a function of two parameters, the base and the power, with which it decides whether a prefix is allowed for the unit. It defaults to allowing all defined prefixes.
Defines a unit prefix such as kilo in kilometre. Apart from the name the power is required (3 for kilo) together with the base that defaults to 10. An abbreviation for the prefix is also allowed which will be used in combination with abbreviated units.
Takes a unit and looks up aliases and abbreviations of unit factors and replaces them with the main unit designators.
Divides the given units with each, reducing the result.
Calculates the error function.
Checks whether a quantity is without uncertainty/error.
Expands the given unit into base units and reduces them
Converts a single unit factor into its expansion of base units, together with a conversion factor
Checks whether a quantity has uncertainty/error.
Checks whether the given quantity has a unit.
Inverse error function.
Tests efficiently whether the length of the list is equal to the given length.
Tests efficiently whether the length of the list is greater than the given length.
Tests efficiently whether the length of list-a is equal to the length of list-b.
Makes a list out of the given object unless it already is a list.
Multiplies units with each other and reduces the result.
Raises the unit to the given power.
Pythagorean addition
Calculates the quantile for the normal distribution.
Helper for the inverf function.
Helper for the inverf function.
The read macro #q(...) is an abbreviation for (quantity ...) which does not transform lowercase symbols to uppercase for unit factors.
The read macro #u(...) is an abbreviation for (mkunit ...) which does not transform lowercase symbols to uppercase.
Reduces the powers of duplicate unit factors in a given unit, e.g. km^2 / km -> km, but m / km -> m / km. No unit lookup is made.
Extracts the root from the given unit if possible. Converts to base units if necessary.
Sorts the unit by positive and negative powers.
Checks whether the given quantity is unitless.
Generic error for quantity definitions.
Semantic error in the definition of a quantity/unit
Syntax error in the definition of a quantity/unit
| Jump to: | (
A B C D E F G H I L M N P Q R S T U V W X |
|---|
| Jump to: | (
A B C D E F G H I L M N P Q R S T U V W X |
|---|
| Jump to: | *
E P S U V |
|---|
| Jump to: | *
E P S U V |
|---|
| Jump to: | C E F I N O P Q R S U |
|---|
| Jump to: | C E F I N O P Q R S U |
|---|