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 }
  28 "To test if a set is the empty set:"
  29 { $subsections null? }
  30 "Basic mathematical operations, which any type of set may override for efficiency:"
  31 { $subsections
  32     diff
  33     intersect
  34     union
  35 }
  36 "Mathematical predicates on sets, which may be overridden for efficiency:"
  37 { $subsections
  38     intersects?
  39     subset?
  40     set=
  41 }
  42 "An optional generic word for creating sets of the same class as a given set:"
  43 { $subsections set-like }
  44 "An optional generic word for creating a set with a fast lookup operation, if the set itself has a slow lookup operation:"
  45 { $subsections fast-set }
  46 "For set types that allow duplicates, like sequence sets, some additional words test for duplication:"
  47 { $subsections
  48     all-unique?
  49     duplicates
  50 }
  51 "Utilities for sets and sequences:"
  52 { $subsections
  53      within
  54      without
  55 } ;
  56
  57 ARTICLE: "set-implementations" "Set implementations"
  58 "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."
  59 { $subsections
  60     "sequence-sets"
  61     "hash-sets"
  62     "bit-sets"
  63 } ;
  64
  65 ARTICLE: "sequence-sets" "Sequences as sets"
  66 "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."
  67 $nl
  68 "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."
  69 $nl
  70 "As one particular example, " { $link POSTPONE: f } " is a representation of the empty set, since it is an empty sequence." ;
  71
  72 HELP: set
  73 { $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." } ;
  74
  75 HELP: adjoin
  76 { $values { "elt" object } { "set" set } }
  77 { $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." }
  78 { $examples
  79     { $example
  80         "USING: prettyprint sets kernel ;"
  81         "V{ \"beans\" \"salsa\" \"cheese\" } clone"
  82         "\"nachos\" over adjoin"
  83         "\"salsa\" over adjoin"
  84         "."
  85         "V{ \"beans\" \"cheese\" \"nachos\" \"salsa\" }"
  86     }
  87 }
  88 { $side-effects "set" } ;
  89
  90 HELP: delete
  91 { $values { "elt" object } { "set" set } }
  92 { $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." }
  93 { $side-effects "set" } ;
  94
  95 HELP: members
  96 { $values { "set" set } { "seq" sequence } }
  97 { $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." } ;
  98
  99 HELP: in?
 100 { $values { "elt" object } { "set" set } { "?" "a boolean" } }
 101 { $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." } ;
 102
 103 HELP: adjoin-at
 104 { $values { "value" object } { "key" object } { "assoc" assoc } }
 105 { $description "Adds " { $snippet "value" } " to the set stored at " { $snippet "key" } " of " { $snippet "assoc" } "." }
 106 { $side-effects "assoc" } ;
 107
 108 HELP: duplicates
 109 { $values { "set" set } { "seq" sequence } }
 110 { $description "Outputs a sequence consisting of elements which occur more than once in " { $snippet "set" } "." }
 111 { $examples
 112     { $example "USING: sets prettyprint ;" "{ 1 2 3 1 2 1 } duplicates ." "{ 1 2 1 }" }
 113 } ;
 114
 115 HELP: all-unique?
 116 { $values { "set" set } { "?" "a boolean" } }
 117 { $description "Tests whether a set contains any repeated elements." }
 118 { $example
 119     "USING: sets prettyprint ;"
 120     "{ 0 1 1 2 3 5 } all-unique? ."
 121     "f"
 122 } ;
 123
 124 HELP: diff
 125 { $values { "set1" set } { "set2" set } { "set" set } }
 126 { $description "Outputs a set consisting of elements present in " { $snippet "set1" } " but not " { $snippet "set2" } ", comparing elements for equality."
 127 "This word has a default definition which works for all sets, but set implementations may override the default for efficiency."
 128 } { $examples
 129     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } diff ." "{ 1 }" }
 130 } ;
 131
 132 HELP: intersect
 133 { $values { "set1" set } { "set2" set } { "set" set } }
 134 { $description "Outputs a set consisting of elements present in both " { $snippet "set1" } " and " { $snippet "set2" } "."
 135 "This word has a default definition which works for all sets, but set implementations may override the default for efficiency." }
 136 { $examples
 137     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } intersect ." "{ 2 3 }" }
 138 } ;
 139
 140 HELP: union
 141 { $values { "set1" set } { "set2" set } { "set" set } }
 142 { $description "Outputs a set consisting of elements present in either " { $snippet "set1" } " or " { $snippet "set2" } " which does not contain duplicate values."
 143 "This word has a default definition which works for all sets, but set implementations may override the default for efficiency." }
 144 { $examples
 145     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } union ." "{ 1 2 3 4 }" }
 146 } ;
 147
 148 { diff intersect union } related-words
 149
 150 HELP: intersects?
 151 { $values { "set1" set } { "set2" set } { "?" "a boolean" } }
 152 { $description "Tests if " { $snippet "set1" } " and " { $snippet "set2" } " have any elements in common." }
 153 { $notes "If one of the sets is empty, the result is always " { $link f } "." } ;
 154
 155 HELP: subset?
 156 { $values { "set1" set } { "set2" set } { "?" "a boolean" } }
 157 { $description "Tests if every element of " { $snippet "set1" } " is contained in " { $snippet "set2" } "." }
 158 { $notes "If " { $snippet "set1" } " is empty, the result is always " { $link t } "." } ;
 159
 160 HELP: set=
 161 { $values { "set1" set } { "set2" set } { "?" "a boolean" } }
 162 { $description "Tests if both sets contain the same elements, disregrading order and duplicates." } ;
 163
 164 HELP: gather
 165 { $values
 166      { "seq" sequence } { "quot" quotation }
 167      { "newseq" sequence } }
 168 { $description "Maps a quotation onto a sequence, concatenates the results of the mapping, and removes duplicates." } ;
 169
 170 HELP: set-like
 171 { $values { "set" set } { "exemplar" set } { "set'" set } }
 172 { $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
 173 "Set implementations may optionally implement a method on this generic word. The default implementation returns its input set." }
 174 { $examples
 175     { $example "USING: sets prettyprint ;" "{ 1 2 3 } HS{ } set-like ." "HS{ 1 2 3 }" }
 176 } ;
 177
 178 HELP: within
 179 { $values { "seq" sequence } { "set" set } { "subseq" sequence } }
 180 { $description "Returns the subsequence of the given sequence consisting of members of the set. This may contain duplicates, if the sequence has duplicates." } ;
 181
 182 HELP: without
 183 { $values { "seq" sequence } { "set" set } { "subseq" sequence } }
 184 { $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." } ;
 185
 186 HELP: null?
 187 { $values { "set" set } { "?" "a boolean" } }
 188 { $description "Tests whether the given set is empty. This outputs " { $snippet "t" } " when given a null set of any type." } ;
 189
 190 HELP: cardinality
 191 { $values { "set" set } { "n" "a non-negative integer" } }
 192 { $description "Returns the number of elements in the set. All sets support this operation." } ;