Skip to content

Commit 455396e

Browse files
committed
Update names in README
1 parent fcd8a9c commit 455396e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

units/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ used. For example, the gravitational force between two bodies is
2525
2)^2`, regardless of whether the distance is given in meters or feet
2626
or centimeters. In other words, every law of nature is unit-polymorphic.
2727

28-
The _units_ package supports unit-polymorphic programs through the coherent
29-
system of units (CSU) mechanism. A CSU is essentially a mapping from
28+
The _units_ package supports unit-polymorphic programs through the locally coherent
29+
system of units (LCSU) mechanism. An LCSU is essentially a mapping from
3030
dimensions to the units. All dimensioned quantities (generally just called
3131
quantities) are expressed using the `Qu` type. The `Qu` type constructor takes
3232
a (perhaps compound) dimension, a CSU and a numerical value type as arguments.
3333
Internally, the quantity is stored as a number in the units as specified in
34-
the CSU -- this may matter if you are worried about rounding errors. In the
35-
sequence of computations that works within one CSU, there is no unit
34+
the LCSU -- this may matter if you are worried about rounding errors. In the
35+
sequence of computations that works within one LCSU, there is no unit
3636
conversion. Unit conversions are needed only when putting values in and out of
37-
quantities, or converting between two different CSUs.
37+
quantities, or converting between two different LCSUs.
3838

3939
Checking out units
4040
------------------
@@ -192,7 +192,7 @@ To perform computations with _units_, we must define a so-called _local coherent
192192
set of units_, or LCSU. This is a mapping from dimensions to units, and it informs
193193
exactly how the quantities are stored. For example:
194194

195-
type LCSU = MkLCSU '[(LengthDim, Meter), (TimeDim, Second)]
195+
type MyLCSU = MkLCSU '[(LengthDim, Meter), (TimeDim, Second)]
196196

197197
This definition says that we wish to store lengths in meters and times in seconds.
198198
Note that, even though `Meter` is defined as the `Canonical` length, we could have
@@ -205,12 +205,12 @@ Value types
205205
To use all these pieces to build the actual type that will store quantities, we
206206
use one of the `MkQu_xxx` type synonyms, as follows:
207207

208-
type Length = MkQu_DLN LengthDim LCSU Double
208+
type Length = MkQu_DLN LengthDim MyLCSU Double
209209
-- Length stores lengths in our defined LCSU, using `Double` as the numerical type
210-
type Length' = MkQu_ULN Foot LCSU Double
210+
type Length' = MkQu_ULN Foot MyLCSU Double
211211
-- same as Length. Note the `U` in `MkQu_ULN`, allowing it to take a unit
212212

213-
type Time = MkQu_DLN TimeDim LCSU Double
213+
type Time = MkQu_DLN TimeDim MyLCSU Double
214214

215215
Some computations
216216
-----------------

0 commit comments

Comments
 (0)