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