core/classes/algebra/algebra-docs.factor

   1 USING: help.markup help.syntax kernel classes words\r
   2 checksums checksums.crc32 sequences math ;\r
   3 IN: classes.algebra\r
   4 \r
   5 ARTICLE: "class-operations" "Class operations"\r
   6 "Set-theoretic operations on classes:"\r
   7 { $subsection class< }\r
   8 { $subsection class<= }\r
   9 { $subsection class-and }\r
  10 { $subsection class-or }\r
  11 { $subsection classes-intersect? }\r
  12 { $subsection min-class }\r
  13 "Low-level implementation detail:"\r
  14 { $subsection class-types }\r
  15 { $subsection flatten-class }\r
  16 { $subsection flatten-builtin-class }\r
  17 { $subsection class-types }\r
  18 { $subsection class-tags } ;\r
  19 \r
  20 ARTICLE: "class-linearization" "Class linearization"\r
  21 "Classes have an intrinsic partial order; given two classes A and B, we either have that A is a subset of B, B is a subset of A, A and B are equal as sets, or they are incomparable. The last two situations present difficulties for method dispatch:"\r
  22 { $list\r
  23     "If a generic word defines a method on a mixin class A and another class B, and B is the only instance of A, there is an ambiguity because A and B are equal as sets; any object that is an instance of one is an instance of both."\r
  24     { "If a generic word defines methods on two union classes which are incomparable but not disjoint, for example " { $link sequence } " and " { $link number } ", there is an ambiguity because the generic word may be called on an object that is an instance of both unions." }\r
  25 }\r
  26 "The first ambiguity is resolved with a tie-breaker that compares metaclasses. The intrinsic meta-class order, from most-specific to least-specific:"\r
  27 { $list\r
  28     "Built-in classes and tuple classes"\r
  29     "Predicate classes"\r
  30     "Union classes"\r
  31     "Mixin classes"\r
  32 }\r
  33 "This means that in the above example, the generic word with methods on a mixin and its sole instance will always call the method for the sole instance, since it is more specific than a mixin class."\r
  34 $nl\r
  35 "The second problem is resolved with another tie-breaker. When performing the topological sort of classes, if there are multiple candidates at any given step of the sort, lexicographical order on the class name is used."\r
  36 $nl\r
  37 "Operations:"\r
  38 { $subsection class< }\r
  39 { $subsection sort-classes }\r
  40 "Metaclass order:"\r
  41 { $subsection rank-class } ;\r
  42 \r
  43 HELP: flatten-builtin-class\r
  44 { $values { "class" class } { "assoc" "an assoc whose keys are classes" } }\r
  45 { $description "Outputs a set of tuple classes whose union is the smallest cover of " { $snippet "class" } " intersected with " { $link tuple } "." } ;\r
  46 \r
  47 HELP: flatten-class\r
  48 { $values { "class" class } { "assoc" "an assoc whose keys are classes" } }\r
  49 { $description "Outputs a set of builtin and tuple classes whose union is the smallest cover of " { $snippet "class" } "." } ;\r
  50 \r
  51 HELP: class-types\r
  52 { $values { "class" class } { "seq" "an increasing sequence of integers" } }\r
  53 { $description "Outputs a sequence of builtin type numbers whose instances can possibly be instances of the given class." } ;\r
  54 \r
  55 HELP: class<=\r
  56 { $values { "first" "a class" } { "second" "a class" } { "?" "a boolean" } }\r
  57 { $description "Tests if all instances of " { $snippet "class1" } " are also instances of " { $snippet "class2" } "." }\r
  58 { $notes "Classes are partially ordered. This means that if " { $snippet "class1 <= class2" } " and " { $snippet "class2 <= class1" } ", then " { $snippet "class1 = class2" } ". Also, if " { $snippet "class1 <= class2" } " and " { $snippet "class2 <= class3" } ", then " { $snippet "class1 <= class3" } "." } ;\r
  59 \r
  60 HELP: sort-classes\r
  61 { $values { "seq" "a sequence of class" } { "newseq" "a new seqence of classes" } }\r
  62 { $description "Outputs a linear sort of a sequence of classes. Larger classes come before their subclasses." } ;\r
  63 \r
  64 HELP: class-or\r
  65 { $values { "first" class } { "second" class } { "class" class } }\r
  66 { $description "Outputs the smallest anonymous class containing both " { $snippet "class1" } " and " { $snippet "class2" } "." } ;\r
  67 \r
  68 HELP: class-and\r
  69 { $values { "first" class } { "second" class } { "class" class } }\r
  70 { $description "Outputs the largest anonymous class contained in both " { $snippet "class1" } " and " { $snippet "class2" } "." } ;\r
  71 \r
  72 HELP: classes-intersect?\r
  73 { $values { "first" class } { "second" class } { "?" "a boolean" } }\r
  74 { $description "Tests if two classes have a non-empty intersection. If the intersection is empty, no object can be an instance of both classes at once." } ;\r
  75 \r
  76 HELP: min-class\r
  77 { $values { "class" class } { "seq" "a sequence of class words" } { "class/f" "a class word or " { $link f } } }\r
  78 { $description "If all classes in " { $snippet "seq" } " that intersect " { $snippet "class" } " are subtypes of " { $snippet "class" } ", outputs the last such element of " { $snippet "seq" } ". If any conditions fail to hold, outputs " { $link f } "." } ;\r