aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/math/random.lux
diff options
context:
space:
mode:
authorEduardo Julian2022-07-28 18:58:20 -0400
committerEduardo Julian2022-07-28 18:58:20 -0400
commit2d125c27e1ceb0adc14fd82f6984b70a12eda650 (patch)
treefcefab088b8346ba009ec4069d3b392486bcad98 /stdlib/source/documentation/lux/math/random.lux
parenta4b64bf1cdf47160b6b615d2c6493039abfd7a94 (diff)
Extracted test-coverage machinery into its own module.
Diffstat (limited to '')
-rw-r--r--stdlib/source/documentation/lux/math/random.lux221
1 files changed, 111 insertions, 110 deletions
diff --git a/stdlib/source/documentation/lux/math/random.lux b/stdlib/source/documentation/lux/math/random.lux
index 1ff5a15a2..d9c6ef729 100644
--- a/stdlib/source/documentation/lux/math/random.lux
+++ b/stdlib/source/documentation/lux/math/random.lux
@@ -1,6 +1,6 @@
(.require
[library
- [lux (.except or and nat int rev)
+ [lux (.except)
["$" documentation]
[data
["[0]" text (.only \n)
@@ -8,112 +8,113 @@
[\\library
["[0]" /]])
-(.def .public documentation
- (.List $.Module)
- ($.module /._
- "Pseudo-random number generation (PRNG) algorithms."
- [($.definition /.functor)
- ($.definition /.apply)
- ($.definition /.monad)
-
- ($.definition /.bit)
- ($.definition /.i64)
- ($.definition /.nat)
- ($.definition /.int)
- ($.definition /.rev)
- ($.definition /.frac)
- ($.definition /.char)
-
- ($.definition /.unicode)
- ($.definition /.ascii)
- ($.definition /.alphabetic)
- ($.definition /.alpha_numeric)
- ($.definition /.numeric)
- ($.definition /.upper_case)
- ($.definition /.lower_case)
-
- ($.definition /.ratio)
- ($.definition /.complex)
-
- ($.definition /.maybe)
- ($.definition /.list)
- ($.definition /.sequence)
- ($.definition /.array)
- ($.definition /.queue)
- ($.definition /.stack)
-
- ($.definition /.instant)
- ($.definition /.date)
- ($.definition /.time)
- ($.definition /.duration)
- ($.definition /.month)
- ($.definition /.day)
-
- ($.definition /.PRNG
- "An abstract way to represent any PRNG.")
-
- ($.definition (/.Random it)
- "A producer of random values based on a PRNG.")
-
- ($.definition /.only
- "Retries the generator until the output satisfies a predicate."
- [(only pred gen)])
-
- ($.definition /.one
- ""
- [(one check random)])
-
- ($.definition /.refined
- "Retries the generator until the output can be refined."
- [(refined refiner gen)])
-
- ($.definition /.safe_frac
- "A number in the interval [0.0,1.0].")
-
- ($.definition /.text
- ""
- [(text char_gen size)])
-
- ($.definition /.and
- "Sequencing combinator."
- [(and left right)])
-
- ($.definition /.or
- "Heterogeneous alternative combinator."
- [(or left right)])
-
- ($.definition /.either
- "Homogeneous alternative combinator."
- [(either left right)])
-
- ($.definition /.rec
- "A combinator for producing recursive random generators."
- [(rec gen)])
-
- ($.definition /.set
- ""
- [(set hash size value_gen)])
-
- ($.definition /.dictionary
- ""
- [(dictionary hash size key_gen value_gen)])
-
- ($.definition /.result
- ""
- [(result prng calc)])
-
- ($.definition /.prng
- ""
- [(prng update return)])
-
- ($.definition /.pcg_32
- (format "An implementation of the PCG32 algorithm."
- \n "For more information, please see: http://www.pcg-random.org/"))
-
- ($.definition /.xoroshiro_128+
- (format "An implementation of the Xoroshiro128+ algorithm."
- \n "For more information, please see: http://xoroshiro.di.unimi.it/"))
-
- ($.definition /.split_mix_64
- "An implementation of the SplitMix64 algorithm.")]
- []))
+(def .public documentation
+ (List $.Documentation)
+ (list ($.module /._
+ "Pseudo-random number generation (PRNG) algorithms.")
+
+ ($.definition /.functor)
+ ($.definition /.apply)
+ ($.definition /.monad)
+
+ ($.definition /.bit)
+ ($.definition /.i64)
+ ($.definition /.nat)
+ ($.definition /.int)
+ ($.definition /.rev)
+ ($.definition /.frac)
+ ($.definition /.char)
+
+ ($.definition /.unicode)
+ ($.definition /.ascii)
+ ($.definition /.alphabetic)
+ ($.definition /.alpha_numeric)
+ ($.definition /.numeric)
+ ($.definition /.upper_case)
+ ($.definition /.lower_case)
+
+ ($.definition /.ratio)
+ ($.definition /.complex)
+
+ ($.definition /.maybe)
+ ($.definition /.list)
+ ($.definition /.sequence)
+ ($.definition /.array)
+ ($.definition /.queue)
+ ($.definition /.stack)
+
+ ($.definition /.instant)
+ ($.definition /.date)
+ ($.definition /.time)
+ ($.definition /.duration)
+ ($.definition /.month)
+ ($.definition /.day)
+
+ ($.definition /.PRNG
+ "An abstract way to represent any PRNG.")
+
+ ($.definition (/.Random it)
+ "A producer of random values based on a PRNG.")
+
+ ($.definition /.only
+ "Retries the generator until the output satisfies a predicate."
+ [(only pred gen)])
+
+ ($.definition /.one
+ ""
+ [(one check random)])
+
+ ($.definition /.refined
+ "Retries the generator until the output can be refined."
+ [(refined refiner gen)])
+
+ ($.definition /.safe_frac
+ "A number in the interval [0.0,1.0].")
+
+ ($.definition /.text
+ ""
+ [(text char_gen size)])
+
+ ($.definition /.and
+ "Sequencing combinator."
+ [(and left right)])
+
+ ($.definition /.or
+ "Heterogeneous alternative combinator."
+ [(or left right)])
+
+ ($.definition /.either
+ "Homogeneous alternative combinator."
+ [(either left right)])
+
+ ($.definition /.rec
+ "A combinator for producing recursive random generators."
+ [(rec gen)])
+
+ ($.definition /.set
+ ""
+ [(set hash size value_gen)])
+
+ ($.definition /.dictionary
+ ""
+ [(dictionary hash size key_gen value_gen)])
+
+ ($.definition /.result
+ ""
+ [(result prng calc)])
+
+ ($.definition /.prng
+ ""
+ [(prng update return)])
+
+ ($.definition /.pcg_32
+ (format "An implementation of the PCG32 algorithm."
+ \n "For more information, please see: http://www.pcg-random.org/"))
+
+ ($.definition /.xoroshiro_128+
+ (format "An implementation of the Xoroshiro128+ algorithm."
+ \n "For more information, please see: http://xoroshiro.di.unimi.it/"))
+
+ ($.definition /.split_mix_64
+ "An implementation of the SplitMix64 algorithm.")
+ ))