aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/abstract/predicate.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/documentation/lux/abstract/predicate.lux')
-rw-r--r--stdlib/source/documentation/lux/abstract/predicate.lux50
1 files changed, 50 insertions, 0 deletions
diff --git a/stdlib/source/documentation/lux/abstract/predicate.lux b/stdlib/source/documentation/lux/abstract/predicate.lux
new file mode 100644
index 000000000..a71326b98
--- /dev/null
+++ b/stdlib/source/documentation/lux/abstract/predicate.lux
@@ -0,0 +1,50 @@
+(.module:
+ [library
+ [lux
+ ["$" documentation (#+ documentation:)]
+ [data
+ [text (#+ \n)
+ ["%" format (#+ format)]]]]]
+ [\\library
+ ["." /]])
+
+(documentation: /.Predicate
+ "A question that can be asked of a value, yield either false (#0) or true (#1).")
+
+(documentation: /.none
+ "A predicate that always fails.")
+
+(documentation: /.or
+ "A predicate that meets either predecessor.")
+
+(documentation: /.all
+ "A predicate that always succeeds.")
+
+(documentation: /.and
+ "A predicate that meets both predecessors.")
+
+(documentation: /.complement
+ "The opposite of a predicate.")
+
+(documentation: /.difference
+ "A predicate that meeds 'base', but not 'sub'.")
+
+(documentation: /.rec
+ "Ties the knot for a recursive predicate.")
+
+(.def: .public documentation
+ (.List $.Module)
+ ($.module /._
+ ""
+ [..Predicate
+ ..none
+ ..or
+ ..all
+ ..and
+ ..complement
+ ..difference
+ ..rec
+ ($.default /.union)
+ ($.default /.intersection)
+ ($.default /.functor)]
+ []))