HelpSource/Classes/Set.schelp

   1 CLASS::Set
   2 summary::a set according to equality
   3 related::Classes/IdentitySet, Classes/List, Classes/Dictionary
   4 categories::Collections>Unordered
   5
   6 DESCRIPTION::
   7 A Set is s collection of objects, no two of which are equal. Most of its methods are inherited from Collection. The contents of a Set are unordered. You must not depend on the order of items in a set. For an ordered set, see link::Classes/OrderedIdentitySet::.
   8
   9 INSTANCEMETHODS::
  10
  11 private::initSet, putCheck, fullCheck, grow, noCheckAdd
  12
  13 subsection::Adding and Removing
  14
  15 method::add
  16 Add anObject to the Set. An object which is equal to an object already in the Set will not be added.
  17 code::
  18 Set[1, 2, 3].add(4).postln;
  19 Set[1, 2, 3].add(3).postln;
  20 Set["abc", "def", "ghi"].add("jkl").postln;
  21 Set["abc", "def", "ghi"].add("def").postln;
  22 ::
  23
  24 method::remove
  25 Remove anObject from the Set.
  26 code::
  27 Set[1, 2, 3].remove(3).postln;
  28 ::
  29
  30 subsection::Iteration
  31
  32 method::do
  33 Evaluates function for each item in the Set. The function is passed two arguments, the item and an integer index.
  34 code::
  35 Set[1, 2, 3, 300].do({ arg item, i; item.postln });
  36 ::
  37
  38 method::keyAt
  39 Returns the object at the internal strong::index::. This index is not deterministic.
  40
  41 subsection::Set specific operations
  42
  43 method::sect, &
  44 Return the set theoretical intersection of this and strong::that::.
  45 code::
  46 a = Set[1, 2, 3]; b = Set[2, 3, 4, 5];
  47 sect(a, b);
  48 a & b // shorter syntax
  49 ::
  50
  51 method::union, |
  52 Return the set theoretical union of this and strong::that::.
  53 code::
  54 a = Set[1, 2, 3]; b = Set[2, 3, 4, 5];
  55 union(a, b);
  56 a | b // shorter syntax
  57 ::
  58
  59 method::difference, -
  60 Return the set of all items which are elements of this, but not of strong::that::.
  61 code::
  62 a = Set[1, 2, 3]; b = Set[2, 3, 4, 5];
  63 difference(a, b);
  64 a - b // shorter syntax
  65 ::
  66
  67 method::symmetricDifference, --
  68 Return the set of all items which are not elements of both this and strong::that::.
  69 code::
  70 a = Set[1, 2, 3]; b = Set[2, 3, 4, 5];
  71 symmetricDifference(a, b);
  72 a -- b // shorter syntax
  73 ::
  74
  75 method::isSubsetOf
  76 Returns true if all elements of this are also elements of strong::that::.
  77 code::
  78 a = Set[1, 2, 3, 4];
  79 Set[1, 2].isSubsetOf(a); // true
  80 Set[1, 5].isSubsetOf(a); // false
  81 ::
  82
  83 EXAMPLES::
  84
  85 code::
  86 a = Set[1, 2, 3, 4];
  87 b = a.powerset; // set of all parts
  88 a.isSubsetOf(b); // false: no set is ever part of itself.
  89 b.asArray.reduce(\union) == a; // true parts may not contain other elements that original
  90 b.asArray.reduce(\difference).isEmpty; // true.
  91 ::
  92
  93 code::
  94 // you can use Set to efficiently remove duplicates from an array:
  95
  96 a = [1, 2, 3, 4, 3, 5, 5, 2, 2, 1];
  97 a.as(Set);              // convert to set
  98 a.as(Set).as(Array);    // and convert back
  99 ::