core/sets/sets-docs.factor

   1 USING: assocs hashtables help.markup help.syntax kernel
   2 quotations sequences vectors ;
   3 IN: sets
   4
   5 ARTICLE: "sets" "Sets"
   6 "A set is an unordered list of elements. Words for working with sets are in the " { $vocab-link "sets" } " vocabulary." $nl
   7 "All sets are instances of a mixin class:"
   8 { $subsections
   9     set
  10     set?
  11 }
  12 { $subsections "set-operations" "set-implementations" } ;
  13
  14 ABOUT: "sets"
  15
  16 ARTICLE: "set-operations" "Operations on sets"
  17 "To test if an object is a member of a set:"
  18 { $subsections in? }
  19 "All sets can be represented as a sequence, without duplicates, of their members:"
  20 { $subsections members }
  21 "To get the number of elements in a set:"
  22 { $subsections cardinality }
  23 "Sets can have members added or removed destructively:"
  24 { $subsections
  25     adjoin
  26     delete
  27     clear-set
  28     union!
  29     diff!
  30     intersect!
  31 }
  32 "To test if a set is the empty set:"
  33 { $subsections null? }
  34 "Basic mathematical operations, which any type of set may override for efficiency:"
  35 { $subsections
  36     diff
  37     intersect
  38     union
  39 }
  40 "Mathematical predicates on sets, which may be overridden for efficiency:"
  41 { $subsections
  42     intersects?
  43     subset?
  44     set=
  45 }
  46 "An optional generic word for creating sets of the same class as a given set:"
  47 { $subsections set-like }
  48 "An optional generic word for creating a set with a fast lookup operation, if the set itself has a slow lookup operation:"
  49 { $subsections fast-set }
  50 "For set types that allow duplicates, like sequence sets, some additional words test for duplication:"
  51 { $subsections
  52     all-unique?
  53     duplicates
  54 }
  55 "Utilities for sets and sequences:"
  56 { $subsections
  57      within
  58      without
  59 } ;
  60
  61 ARTICLE: "set-implementations" "Set implementations"
  62 "There are several implementations of sets in the Factor library. More can be added if they implement the words of the set protocol, the basic set operations."
  63 { $subsections
  64     "sequence-sets"
  65     "hash-sets"
  66     "bit-sets"
  67 } ;
  68
  69 ARTICLE: "sequence-sets" "Sequences as sets"
  70 "Any sequence can be used as a set. The members of this set are the elements of the sequence. Calling the word " { $link members } " on a sequence returns a copy of the sequence with only one listing of each member. Destructive operations " { $link adjoin } " and " { $link delete } " only work properly on growable sequences like " { $link vector } "s."
  71 $nl
  72 "Care must be taken in writing efficient code using sequence sets. Testing for membership with " { $link in? } ", as well as the destructive set operations, take time proportional to the size of the sequence. Another representation, like " { $link "hash-sets" } ", would take constant time for membership tests. But binary operations like " { $link union } " are asymptotically optimal, taking time proportional to the sum of the size of the inputs."
  73 $nl
  74 "As one particular example, " { $link POSTPONE: f } " is a representation of the empty set, since it is an empty sequence." ;
  75
  76 HELP: set
  77 { $class-description "The class of all sets. Custom implementations of the set protocol should be declared as instances of this mixin for all set implementation to work correctly." } ;
  78
  79 HELP: adjoin
  80 { $values { "elt" object } { "set" set } }
  81 { $description "Destructively adds " { $snippet "elt" } " to " { $snippet "set" } ". For sequences, this guarantees that this element is not duplicated, and that it is at the end of the sequence." $nl "Each mutable set type is expected to implement a method on this generic word." }
  82 { $examples
  83     { $example
  84         "USING: prettyprint sets kernel ;"
  85         "V{ \"beans\" \"salsa\" \"cheese\" } clone"
  86         "\"nachos\" over adjoin"
  87         "\"salsa\" over adjoin"
  88         "."
  89         "V{ \"beans\" \"cheese\" \"nachos\" \"salsa\" }"
  90     }
  91 }
  92 { $side-effects "set" } ;
  93
  94 HELP: ?adjoin
  95 { $values { "elt" object } { "set" set } { "?" boolean } }
  96 { $description "A version of " { $link adjoin } " which returns whether the element was added to the set." }
  97 { $notes "This is slightly less efficient than " { $link adjoin } " due to the initial membership test." } ;
  98
  99 HELP: delete
 100 { $values { "elt" object } { "set" set } }
 101 { $description "Destructively removes " { $snippet "elt" } " from " { $snippet "set" } ". If the element is not present, this does nothing." $nl "Each mutable set type is expected to implement a method on this generic word." }
 102 { $side-effects "set" } ;
 103
 104 HELP: clear-set
 105 { $values { "set" set } }
 106 { $contract "Removes all entries from the set." }
 107 { $side-effects "set" } ;
 108
 109 HELP: members
 110 { $values { "set" set } { "seq" sequence } }
 111 { $description "Creates a sequence with a single copy of each member of the set." $nl "Each set type is expected to implement a method on this generic word." } ;
 112
 113 HELP: in?
 114 { $values { "elt" object } { "set" set } { "?" boolean } }
 115 { $description "Tests whether the element is a member of the set." $nl "Each set type is expected to implement a method on this generic word as part of the set protocol." } ;
 116
 117 HELP: adjoin-at
 118 { $values { "value" object } { "key" object } { "assoc" assoc } }
 119 { $description "Adds " { $snippet "value" } " to the set stored at " { $snippet "key" } " of " { $snippet "assoc" } "." }
 120 { $side-effects "assoc" } ;
 121
 122 HELP: duplicates
 123 { $values { "set" set } { "seq" sequence } }
 124 { $description "Outputs a sequence consisting of elements which occur more than once in " { $snippet "set" } "." }
 125 { $examples
 126     { $example "USING: sets prettyprint ;" "{ 1 2 3 1 2 1 } duplicates ." "{ 1 2 1 }" }
 127 } ;
 128
 129 HELP: all-unique?
 130 { $values { "set" set } { "?" boolean } }
 131 { $description "Tests whether a set contains any repeated elements." }
 132 { $example
 133     "USING: sets prettyprint ;"
 134     "{ 0 1 1 2 3 5 } all-unique? ."
 135     "f"
 136 } ;
 137
 138 HELP: diff
 139 { $values { "set1" set } { "set2" set } { "set" set } }
 140 { $description "Outputs a set consisting of elements present in " { $snippet "set1" } " but not " { $snippet "set2" } ", comparing elements for equality." $nl "This word has a default definition which works for all sets, but set implementations may override the default for efficiency."
 141 } { $examples
 142     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } diff ." "{ 1 }" }
 143 } ;
 144
 145 HELP: intersect
 146 { $values { "set1" set } { "set2" set } { "set" set } }
 147 { $description "Outputs a set consisting of elements present in both " { $snippet "set1" } " and " { $snippet "set2" } "."
 148 "This word has a default definition which works for all sets, but set implementations may override the default for efficiency." }
 149 { $examples
 150     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } intersect ." "{ 2 3 }" }
 151 } ;
 152
 153 HELP: intersection
 154 { $values { "sets" sequence } { "set/f" { $maybe set } } }
 155 { $description "Outputs the intersection of all the sets of the sequence " { $snippet "sets" } ", or " { $link f } " if " { $snippet "sets" } " is empty." } ;
 156
 157 HELP: union
 158 { $values { "set1" set } { "set2" set } { "set" set } }
 159 { $description "Outputs a set consisting of elements present in either " { $snippet "set1" } " or " { $snippet "set2" } " which does not contain duplicate values." $nl "This word has a default definition which works for all sets, but set implementations may override the default for efficiency." }
 160 { $examples
 161     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } union ." "{ 1 2 3 4 }" }
 162 } ;
 163
 164 { diff intersect union } related-words
 165
 166 HELP: union!
 167 { $values { "set1" set } { "set2" set } }
 168 { $description "Adds all members from " { $snippet "set2" } " to " { $snippet "set1" } "." }
 169 { $side-effects "set1" } ;
 170
 171 HELP: diff!
 172 { $values { "set1" set } { "set2" set } }
 173 { $description "Removes all members from " { $snippet "set1" } " contained in " { $snippet "set2" } "." }
 174 { $side-effects "set1" } ;
 175
 176 HELP: intersect!
 177 { $values { "set1" set } { "set2" set } }
 178 { $description "Removes all members from " { $snippet "set1" } " not contained in " { $snippet "set2" } "." }
 179 { $side-effects "set1" } ;
 180
 181 HELP: intersects?
 182 { $values { "set1" set } { "set2" set } { "?" boolean } }
 183 { $description "Tests if " { $snippet "set1" } " and " { $snippet "set2" } " have any elements in common." }
 184 { $notes "If one of the sets is empty, the result is always " { $link f } "." } ;
 185
 186 HELP: subset?
 187 { $values { "set1" set } { "set2" set } { "?" boolean } }
 188 { $description "Tests if every element of " { $snippet "set1" } " is contained in " { $snippet "set2" } "." }
 189 { $notes "If " { $snippet "set1" } " is empty, the result is always " { $link t } "." } ;
 190
 191 HELP: set=
 192 { $values { "set1" set } { "set2" set } { "?" boolean } }
 193 { $description "Tests if both sets contain the same elements, disregrading order and duplicates." } ;
 194
 195 HELP: gather
 196 { $values
 197      { "seq" sequence } { "quot" quotation }
 198      { "newseq" sequence } }
 199 { $description "Maps a quotation onto a sequence, concatenates the results of the mapping, and removes duplicates." } ;
 200
 201 HELP: set-like
 202 { $values { "set" set } { "exemplar" set } { "set'" set } }
 203 { $description "If the conversion is defined for the exemplar, converts the set into a set of the exemplar's class. This is not guaranteed to create a new set, for example if the input set and exemplar are of the same class." $nl "Set implementations may optionally implement a method on this generic word. The default implementation returns its input set." }
 204 { $examples
 205     { $example "USING: sets prettyprint ;" "{ 1 2 3 } HS{ } set-like ." "HS{ 1 2 3 }" }
 206 } ;
 207
 208 HELP: within
 209 { $values { "seq" sequence } { "set" set } { "subseq" sequence } }
 210 { $description "Returns the subsequence of the given sequence consisting of members of the set. This may contain duplicates, if the sequence has duplicates." } ;
 211
 212 HELP: without
 213 { $values { "seq" sequence } { "set" set } { "subseq" sequence } }
 214 { $description "Returns the subsequence of the given sequence consisting of things that are not members of the set. This may contain duplicates, if the sequence has duplicates." } ;
 215
 216 HELP: null?
 217 { $values { "set" set } { "?" boolean } }
 218 { $description "Tests whether the given set is empty. This outputs " { $snippet "t" } " when given a null set of any type." } ;
 219
 220 HELP: cardinality
 221 { $values { "set" set } { "n" "a non-negative integer" } }
 222 { $description "Returns the number of elements in the set. All sets support this operation." } ;
 223
 224 HELP: combine
 225 { $values { "sets" "a sequence of sets" } { "set/f" { $maybe set } } }
 226 { $description "Outputs the union of a sequence of sets, or " { $link f } " if the sequence is empty." } ;