core/sets/sets-docs.factor

   1 USING: assocs hashtables help.markup help.syntax kernel
   2 quotations sequences ;
   3 IN: sets
   4
   5 ARTICLE: "sets" "Set-theoretic operations on sequences"
   6 "Set-theoretic operations on sequences are defined on the " { $vocab-link "sets" } " vocabulary. All of these operations use hashtables internally to achieve linear running time."
   7 $nl
   8 "Remove duplicates:"
   9 { $subsection prune }
  10 "Test for duplicates:"
  11 { $subsection all-unique? }
  12 { $subsection duplicates }
  13 "Set operations on sequences:"
  14 { $subsection diff }
  15 { $subsection intersect }
  16 { $subsection union }
  17 "Set-theoretic predicates:"
  18 { $subsection intersects? }
  19 { $subsection subset? }
  20 { $subsection set= }
  21 "A word used to implement the above:"
  22 { $subsection unique }
  23 "Adding elements to sets:"
  24 { $subsection adjoin }
  25 { $subsection conjoin }
  26 { $subsection conjoin-at }
  27 { $see-also member? memq? any? all? "assocs-sets" } ;
  28
  29 ABOUT: "sets"
  30
  31 HELP: adjoin
  32 { $values { "elt" object } { "seq" "a resizable mutable sequence" } }
  33 { $description "Removes all elements equal to " { $snippet "elt" } ", and adds " { $snippet "elt" } " at the end of the sequence." }
  34 { $examples
  35     { $example
  36         "USING: namespaces prettyprint sets ;"
  37         "V{ \"beans\" \"salsa\" \"cheese\" } \"v\" set"
  38         "\"nachos\" \"v\" get adjoin"
  39         "\"salsa\" \"v\" get adjoin"
  40         "\"v\" get ."
  41         "V{ \"beans\" \"cheese\" \"nachos\" \"salsa\" }"
  42     }
  43 }
  44 { $side-effects "seq" } ;
  45
  46 HELP: conjoin
  47 { $values { "elt" object } { "assoc" assoc } }
  48 { $description "Stores a key/value pair, both equal to " { $snippet "elt" } ", into the assoc." }
  49 { $examples
  50     { $example
  51         "USING: kernel prettyprint sets ;"
  52         "H{ } clone 1 over conjoin ."
  53         "H{ { 1 1 } }"
  54     }
  55 }
  56 { $side-effects "assoc" } ;
  57
  58 HELP: conjoin-at
  59 { $values { "value" object } { "key" object } { "assoc" assoc } }
  60 { $description "Adds " { $snippet "value" } " to the set stored at " { $snippet "key" } " of " { $snippet "assoc" } "." } ;
  61
  62 HELP: unique
  63 { $values { "seq" "a sequence" } { "assoc" assoc } }
  64 { $description "Outputs a new assoc where the keys and values are equal." }
  65 { $examples
  66     { $example "USING: sets prettyprint ;" "{ 1 1 2 2 3 3 } unique ." "H{ { 1 1 } { 2 2 } { 3 3 } }" }
  67 } ;
  68
  69 HELP: prune
  70 { $values { "seq" "a sequence" } { "newseq" "a sequence" } }
  71 { $description "Outputs a new sequence with each distinct element of " { $snippet "seq" } " appearing only once. Elements are compared for equality using " { $link = } " and elements are ordered according to their position in " { $snippet "seq" } "." }
  72 { $examples
  73     { $example "USING: sets prettyprint ;" "{ 1 1 t 3 t } prune ." "V{ 1 t 3 }" }
  74 } ;
  75
  76 HELP: duplicates
  77 { $values { "seq" "a sequence" } { "newseq" "a sequence" } }
  78 { $description "Outputs a new sequence consisting of elements which occur more than once in " { $snippet "seq" } "." }
  79 { $examples
  80     { $example "USING: sets prettyprint ;" "{ 1 2 3 1 2 1 } duplicates ." "{ 1 2 1 }" }
  81 } ;
  82
  83 HELP: all-unique?
  84 { $values { "seq" sequence } { "?" "a boolean" } }
  85 { $description "Tests whether a sequence contains any repeated elements." }
  86 { $example
  87     "USING: sets prettyprint ;"
  88     "{ 0 1 1 2 3 5 } all-unique? ."
  89     "f"
  90 } ;
  91
  92 HELP: diff
  93 { $values { "seq1" sequence } { "seq2" sequence } { "newseq" sequence } }
  94 { $description "Outputs a sequence consisting of elements present in " { $snippet "seq1" } " but not " { $snippet "seq2" } ", comparing elements for equality."
  95 } { $examples
  96     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } diff ." "{ 1 }" }
  97 } ;
  98
  99 HELP: intersect
 100 { $values { "seq1" sequence } { "seq2" sequence } { "newseq" sequence } }
 101 { $description "Outputs a sequence consisting of elements present in both " { $snippet "seq1" } " and " { $snippet "seq2" } "." }
 102 { $examples
 103     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } intersect ." "{ 2 3 }" }
 104 } ;
 105
 106 HELP: union
 107 { $values { "seq1" sequence } { "seq2" sequence } { "newseq" sequence } }
 108 { $description "Outputs a sequence consisting of elements present in " { $snippet "seq1" } " and " { $snippet "seq2" } " which does not contain duplicate values." }
 109 { $examples
 110     { $example "USING: sets prettyprint ;" "{ 1 2 3 } { 2 3 4 } union ." "V{ 1 2 3 4 }" }
 111 } ;
 112
 113 { diff intersect union } related-words
 114
 115 HELP: intersects?
 116 { $values { "seq1" sequence } { "seq2" sequence } { "?" "a boolean" } }
 117 { $description "Tests if " { $snippet "seq1" } " and " { $snippet "seq2" } " have any elements in common." }
 118 { $notes "If one of the sequences is empty, the result is always " { $link f } "." } ;
 119
 120 HELP: subset?
 121 { $values { "seq1" sequence } { "seq2" sequence } { "?" "a boolean" } }
 122 { $description "Tests if every element of " { $snippet "seq1" } " is contained in " { $snippet "seq2" } "." }
 123 { $notes "If " { $snippet "seq1" } " is empty, the result is always " { $link t } "." } ;
 124
 125 HELP: set=
 126 { $values { "seq1" sequence } { "seq2" sequence } { "?" "a boolean" } }
 127 { $description "Tests if both sequences contain the same elements, disregrading order and duplicates." } ;
 128
 129 HELP: gather
 130 { $values
 131      { "seq" sequence } { "quot" quotation }
 132      { "newseq" sequence } }
 133 { $description "Maps a quotation onto a sequence, concatenates the results of the mapping, and removes duplicates." } ;
 134