4 <name>Iesi.Collections</name>
7 <member name="T:Iesi.Collections.Generic.DictionarySet`1">
9 <p><c>DictionarySet</c> is an abstract class that supports the creation of new <c>Set</c>
10 types where the underlying data store is an <c>IDictionary</c> instance.</p>
12 <p>You can use any object that implements the <c>IDictionary</c> interface to hold set data.
13 You can define your own, or you can use one of the objects provided in the Framework.
14 The type of <c>IDictionary</c> you choose will affect both the performance and the behavior
15 of the <c>Set</c> using it. </p>
17 <p>To make a <c>Set</c> typed based on your own <c>IDictionary</c>, simply derive a
18 new class with a constructor that takes no parameters. Some <c>Set</c> implmentations
19 cannot be defined with a default constructor. If this is the case for your class,
20 you will need to override <c>Clone()</c> as well.</p>
22 <p>It is also standard practice that at least one of your constructors takes an <c>ICollection</c> or
23 an <c>ISet</c> as an argument.</p>
26 <member name="T:Iesi.Collections.Generic.Set`1">
27 <summary><p>A collection that contains no duplicate elements. This class models the mathematical
28 <c>Set</c> abstraction, and is the base class for all other <c>Set</c> implementations.
29 The order of elements in a set is dependant on (a)the data-structure implementation, and
30 (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
32 <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
33 in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
35 <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
38 <term>Operation</term>
39 <term>Description</term>
44 <term>Union (OR)</term>
45 <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
46 <term><c>Union()</c></term>
50 <term>Intersection (AND)</term>
51 <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
52 <term><c>InterSect()</c></term>
53 <term><c>&</c></term>
56 <term>Exclusive Or (XOR)</term>
57 <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
58 <term><c>ExclusiveOr()</c></term>
62 <term>Minus (n/a)</term>
63 <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
64 them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
65 <term><c>Minus()</c></term>
71 <member name="T:Iesi.Collections.Generic.ISet`1">
73 <p>A collection that contains no duplicate elements. This interface models the mathematical
74 <c>Set</c> abstraction.
75 The order of elements in a set is dependant on (a)the data-structure implementation, and
76 (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
78 <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
79 in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
81 <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
84 <term>Operation</term>
85 <term>Description</term>
89 <term>Union (OR)</term>
90 <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
91 <term><c>Union()</c></term>
94 <term>Intersection (AND)</term>
95 <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
96 <term><c>InterSect()</c></term>
99 <term>Exclusive Or (XOR)</term>
100 <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
101 <term><c>ExclusiveOr()</c></term>
104 <term>Minus (n/a)</term>
105 <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
106 them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
107 <term><c>Minus()</c></term>
112 <member name="M:Iesi.Collections.Generic.ISet`1.Union(Iesi.Collections.Generic.ISet{`0})">
114 Performs a "union" of the two sets, where all the elements
115 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
116 Neither this set nor the input set are modified during the operation. The return value
117 is a <c>Clone()</c> of this set with the extra elements added in.
119 <param name="a">A collection of elements.</param>
120 <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
121 Neither of the input objects is modified by the union.</returns>
123 <member name="M:Iesi.Collections.Generic.ISet`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
125 Performs an "intersection" of the two sets, where only the elements
126 that are present in both sets remain. That is, the element is included if it exists in
127 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
128 a <c>Clone()</c> of this set with the appropriate elements removed.
130 <param name="a">A set of elements.</param>
131 <returns>The intersection of this set with <c>a</c>.</returns>
133 <member name="M:Iesi.Collections.Generic.ISet`1.Minus(Iesi.Collections.Generic.ISet{`0})">
135 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
136 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
137 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
138 of this <c>Set</c> containing the elements from the operation.
140 <param name="a">A set of elements.</param>
141 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
143 <member name="M:Iesi.Collections.Generic.ISet`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
145 Performs an "exclusive-or" of the two sets, keeping only the elements that
146 are in one of the sets, but not in both. The original sets are not modified
147 during this operation. The result set is a <c>Clone()</c> of this set containing
148 the elements from the exclusive-or operation.
150 <param name="a">A set of elements.</param>
151 <returns>A set containing the result of <c>a ^ b</c>.</returns>
153 <member name="M:Iesi.Collections.Generic.ISet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
155 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
157 <param name="c">A collection of objects.</param>
158 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
160 <member name="M:Iesi.Collections.Generic.ISet`1.Add(`0)">
162 Adds the specified element to this set if it is not already present.
164 <param name="o">The object to add to the set.</param>
165 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
167 <member name="M:Iesi.Collections.Generic.ISet`1.AddAll(System.Collections.Generic.ICollection{`0})">
169 Adds all the elements in the specified collection to the set if they are not already present.
171 <param name="c">A collection of objects to add to the set.</param>
172 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
174 <member name="M:Iesi.Collections.Generic.ISet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
176 Remove all the specified elements from this set, if they exist in this set.
178 <param name="c">A collection of elements to remove.</param>
179 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
181 <member name="M:Iesi.Collections.Generic.ISet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
183 Retains only the elements in this set that are contained in the specified collection.
185 <param name="c">Collection that defines the set of elements to be retained.</param>
186 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
188 <member name="P:Iesi.Collections.Generic.ISet`1.IsEmpty">
190 Returns <see langword="true" /> if this set contains no elements.
193 <member name="T:Iesi.Collections.ISet">
195 <p>A collection that contains no duplicate elements. This interface models the mathematical
196 <c>Set</c> abstraction.
197 The order of elements in a set is dependant on (a)the data-structure implementation, and
198 (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
200 <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
201 in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
203 <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
206 <term>Operation</term>
207 <term>Description</term>
211 <term>Union (OR)</term>
212 <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
213 <term><c>Union()</c></term>
216 <term>Intersection (AND)</term>
217 <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
218 <term><c>InterSect()</c></term>
221 <term>Exclusive Or (XOR)</term>
222 <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
223 <term><c>ExclusiveOr()</c></term>
226 <term>Minus (n/a)</term>
227 <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
228 them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
229 <term><c>Minus()</c></term>
234 <member name="M:Iesi.Collections.ISet.Union(Iesi.Collections.ISet)">
236 Performs a "union" of the two sets, where all the elements
237 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
238 Neither this set nor the input set are modified during the operation. The return value
239 is a <c>Clone()</c> of this set with the extra elements added in.
241 <param name="a">A collection of elements.</param>
242 <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
243 Neither of the input objects is modified by the union.</returns>
245 <member name="M:Iesi.Collections.ISet.Intersect(Iesi.Collections.ISet)">
247 Performs an "intersection" of the two sets, where only the elements
248 that are present in both sets remain. That is, the element is included if it exists in
249 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
250 a <c>Clone()</c> of this set with the appropriate elements removed.
252 <param name="a">A set of elements.</param>
253 <returns>The intersection of this set with <c>a</c>.</returns>
255 <member name="M:Iesi.Collections.ISet.Minus(Iesi.Collections.ISet)">
257 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
258 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
259 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
260 of this <c>Set</c> containing the elements from the operation.
262 <param name="a">A set of elements.</param>
263 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
265 <member name="M:Iesi.Collections.ISet.ExclusiveOr(Iesi.Collections.ISet)">
267 Performs an "exclusive-or" of the two sets, keeping only the elements that
268 are in one of the sets, but not in both. The original sets are not modified
269 during this operation. The result set is a <c>Clone()</c> of this set containing
270 the elements from the exclusive-or operation.
272 <param name="a">A set of elements.</param>
273 <returns>A set containing the result of <c>a ^ b</c>.</returns>
275 <member name="M:Iesi.Collections.ISet.Contains(System.Object)">
277 Returns <see langword="true" /> if this set contains the specified element.
279 <param name="o">The element to look for.</param>
280 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
282 <member name="M:Iesi.Collections.ISet.ContainsAll(System.Collections.ICollection)">
284 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
286 <param name="c">A collection of objects.</param>
287 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
289 <member name="M:Iesi.Collections.ISet.Add(System.Object)">
291 Adds the specified element to this set if it is not already present.
293 <param name="o">The object to add to the set.</param>
294 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
296 <member name="M:Iesi.Collections.ISet.AddAll(System.Collections.ICollection)">
298 Adds all the elements in the specified collection to the set if they are not already present.
300 <param name="c">A collection of objects to add to the set.</param>
301 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
303 <member name="M:Iesi.Collections.ISet.Remove(System.Object)">
305 Removes the specified element from the set.
307 <param name="o">The element to be removed.</param>
308 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
310 <member name="M:Iesi.Collections.ISet.RemoveAll(System.Collections.ICollection)">
312 Remove all the specified elements from this set, if they exist in this set.
314 <param name="c">A collection of elements to remove.</param>
315 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
317 <member name="M:Iesi.Collections.ISet.RetainAll(System.Collections.ICollection)">
319 Retains only the elements in this set that are contained in the specified collection.
321 <param name="c">Collection that defines the set of elements to be retained.</param>
322 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
324 <member name="M:Iesi.Collections.ISet.Clear">
326 Removes all objects from the set.
329 <member name="P:Iesi.Collections.ISet.IsEmpty">
331 Returns <see langword="true" /> if this set contains no elements.
334 <member name="M:Iesi.Collections.Generic.Set`1.Union(Iesi.Collections.Generic.ISet{`0})">
336 Performs a "union" of the two sets, where all the elements
337 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
338 Neither this set nor the input set are modified during the operation. The return value
339 is a <c>Clone()</c> of this set with the extra elements added in.
341 <param name="a">A collection of elements.</param>
342 <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
343 Neither of the input objects is modified by the union.</returns>
345 <member name="M:Iesi.Collections.Generic.Set`1.Union(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
347 Performs a "union" of two sets, where all the elements
348 in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
349 The return value is a <c>Clone()</c> of one of the sets (<c>a</c> if it is not <see langword="null" />) with elements of the other set
350 added in. Neither of the input sets is modified by the operation.
352 <param name="a">A set of elements.</param>
353 <param name="b">A set of elements.</param>
354 <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
356 <member name="M:Iesi.Collections.Generic.Set`1.op_BitwiseOr(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
358 Performs a "union" of two sets, where all the elements
359 in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
360 The return value is a <c>Clone()</c> of one of the sets (<c>a</c> if it is not <see langword="null" />) with elements of the other set
361 added in. Neither of the input sets is modified by the operation.
363 <param name="a">A set of elements.</param>
364 <param name="b">A set of elements.</param>
365 <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
367 <member name="M:Iesi.Collections.Generic.Set`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
369 Performs an "intersection" of the two sets, where only the elements
370 that are present in both sets remain. That is, the element is included if it exists in
371 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
372 a <c>Clone()</c> of this set with the appropriate elements removed.
374 <param name="a">A set of elements.</param>
375 <returns>The intersection of this set with <c>a</c>.</returns>
377 <member name="M:Iesi.Collections.Generic.Set`1.Intersect(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
379 Performs an "intersection" of the two sets, where only the elements
380 that are present in both sets remain. That is, the element is included only if it exists in
381 both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
382 The result object is a <c>Clone()</c> of one of the input objects (<c>a</c> if it is not <see langword="null" />) containing the
383 elements from the intersect operation.
385 <param name="a">A set of elements.</param>
386 <param name="b">A set of elements.</param>
387 <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
389 <member name="M:Iesi.Collections.Generic.Set`1.op_BitwiseAnd(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
391 Performs an "intersection" of the two sets, where only the elements
392 that are present in both sets remain. That is, the element is included only if it exists in
393 both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
394 The result object is a <c>Clone()</c> of one of the input objects (<c>a</c> if it is not <see langword="null" />) containing the
395 elements from the intersect operation.
397 <param name="a">A set of elements.</param>
398 <param name="b">A set of elements.</param>
399 <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
401 <member name="M:Iesi.Collections.Generic.Set`1.Minus(Iesi.Collections.Generic.ISet{`0})">
403 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
404 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
405 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
406 of this <c>Set</c> containing the elements from the operation.
408 <param name="a">A set of elements.</param>
409 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
411 <member name="M:Iesi.Collections.Generic.Set`1.Minus(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
413 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
414 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
415 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
416 of set <c>a</c> containing the elements from the operation.
418 <param name="a">A set of elements.</param>
419 <param name="b">A set of elements.</param>
420 <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
422 <member name="M:Iesi.Collections.Generic.Set`1.op_Subtraction(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
424 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
425 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
426 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
427 of set <c>a</c> containing the elements from the operation.
429 <param name="a">A set of elements.</param>
430 <param name="b">A set of elements.</param>
431 <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
433 <member name="M:Iesi.Collections.Generic.Set`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
435 Performs an "exclusive-or" of the two sets, keeping only the elements that
436 are in one of the sets, but not in both. The original sets are not modified
437 during this operation. The result set is a <c>Clone()</c> of this set containing
438 the elements from the exclusive-or operation.
440 <param name="a">A set of elements.</param>
441 <returns>A set containing the result of <c>a ^ b</c>.</returns>
443 <member name="M:Iesi.Collections.Generic.Set`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
445 Performs an "exclusive-or" of the two sets, keeping only the elements that
446 are in one of the sets, but not in both. The original sets are not modified
447 during this operation. The result set is a <c>Clone()</c> of one of the sets
448 (<c>a</c> if it is not <see langword="null" />) containing
449 the elements from the exclusive-or operation.
451 <param name="a">A set of elements.</param>
452 <param name="b">A set of elements.</param>
453 <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
455 <member name="M:Iesi.Collections.Generic.Set`1.op_ExclusiveOr(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
457 Performs an "exclusive-or" of the two sets, keeping only the elements that
458 are in one of the sets, but not in both. The original sets are not modified
459 during this operation. The result set is a <c>Clone()</c> of one of the sets
460 (<c>a</c> if it is not <see langword="null" />) containing
461 the elements from the exclusive-or operation.
463 <param name="a">A set of elements.</param>
464 <param name="b">A set of elements.</param>
465 <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
467 <member name="M:Iesi.Collections.Generic.Set`1.Add(`0)">
469 Adds the specified element to this set if it is not already present.
471 <param name="o">The object to add to the set.</param>
472 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
474 <member name="M:Iesi.Collections.Generic.Set`1.AddAll(System.Collections.Generic.ICollection{`0})">
476 Adds all the elements in the specified collection to the set if they are not already present.
478 <param name="c">A collection of objects to add to the set.</param>
479 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
481 <member name="M:Iesi.Collections.Generic.Set`1.Clear">
483 Removes all objects from the set.
486 <member name="M:Iesi.Collections.Generic.Set`1.Contains(`0)">
488 Returns <see langword="true" /> if this set contains the specified element.
490 <param name="o">The element to look for.</param>
491 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
493 <member name="M:Iesi.Collections.Generic.Set`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
495 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
497 <param name="c">A collection of objects.</param>
498 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
500 <member name="M:Iesi.Collections.Generic.Set`1.Remove(`0)">
502 Removes the specified element from the set.
504 <param name="o">The element to be removed.</param>
505 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
507 <member name="M:Iesi.Collections.Generic.Set`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
509 Remove all the specified elements from this set, if they exist in this set.
511 <param name="c">A collection of elements to remove.</param>
512 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
514 <member name="M:Iesi.Collections.Generic.Set`1.RetainAll(System.Collections.Generic.ICollection{`0})">
516 Retains only the elements in this set that are contained in the specified collection.
518 <param name="c">Collection that defines the set of elements to be retained.</param>
519 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
521 <member name="M:Iesi.Collections.Generic.Set`1.Clone">
523 Returns a clone of the <c>Set</c> instance. This will work for derived <c>Set</c>
524 classes if the derived class implements a constructor that takes no arguments.
526 <returns>A clone of this object.</returns>
528 <member name="M:Iesi.Collections.Generic.Set`1.CopyTo(`0[],System.Int32)">
530 Copies the elements in the <c>Set</c> to an array. The type of array needs
531 to be compatible with the objects in the <c>Set</c>, obviously.
533 <param name="array">An array that will be the target of the copy operation.</param>
534 <param name="index">The zero-based index where copying will start.</param>
536 <member name="M:Iesi.Collections.Generic.Set`1.GetEnumerator">
538 Gets an enumerator for the elements in the <c>Set</c>.
540 <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
542 <member name="M:Iesi.Collections.Generic.Set`1.NonGenericCopyTo(System.Array,System.Int32)">
544 Performs CopyTo when called trhough non-generic ISet (ICollection) interface
546 <param name="array"></param>
547 <param name="index"></param>
549 <member name="M:Iesi.Collections.Generic.Set`1.NonGenericUnion(Iesi.Collections.ISet)">
551 Performs Union when called trhough non-generic ISet interface
553 <param name="a"></param>
556 <member name="M:Iesi.Collections.Generic.Set`1.NonGenericMinus(Iesi.Collections.ISet)">
558 Performs Minus when called trhough non-generic ISet interface
560 <param name="a"></param>
563 <member name="M:Iesi.Collections.Generic.Set`1.NonGenericIntersect(Iesi.Collections.ISet)">
565 Performs Intersect when called trhough non-generic ISet interface
567 <param name="a"></param>
570 <member name="M:Iesi.Collections.Generic.Set`1.NonGenericExclusiveOr(Iesi.Collections.ISet)">
572 Performs ExclusiveOr when called trhough non-generic ISet interface
574 <param name="a"></param>
577 <member name="P:Iesi.Collections.Generic.Set`1.IsEmpty">
579 Returns <see langword="true" /> if this set contains no elements.
582 <member name="P:Iesi.Collections.Generic.Set`1.Count">
584 The number of elements currently contained in this collection.
587 <member name="P:Iesi.Collections.Generic.Set`1.IsSynchronized">
589 Returns <see langword="true" /> if the <c>Set</c> is synchronized across threads. Note that
590 enumeration is inherently not thread-safe. Use the <c>SyncRoot</c> to lock the
591 object during enumeration.
594 <member name="P:Iesi.Collections.Generic.Set`1.SyncRoot">
596 An object that can be used to synchronize this collection to make it thread-safe.
597 When implementing this, if your object uses a base object, like an <c>IDictionary</c>,
598 or anything that has a <c>SyncRoot</c>, return that object instead of "<c>this</c>".
601 <member name="P:Iesi.Collections.Generic.Set`1.IsReadOnly">
603 Indicates whether the given instance is read-only or not
606 <see langword="true" /> if the ISet is read-only; otherwise, <see langword="false" />.
607 In the default implementation of Set, this property always returns false.
610 <member name="F:Iesi.Collections.Generic.DictionarySet`1.InternalDictionary">
612 Provides the storage for elements in the <c>Set</c>, stored as the key-set
613 of the <c>IDictionary</c> object. Set this object in the constructor
614 if you create your own <c>Set</c> class.
617 <member name="M:Iesi.Collections.Generic.DictionarySet`1.Add(`0)">
619 Adds the specified element to this set if it is not already present.
621 <param name="o">The <typeparamref name="T"/> to add to the set.</param>
622 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
624 <member name="M:Iesi.Collections.Generic.DictionarySet`1.AddAll(System.Collections.Generic.ICollection{`0})">
626 Adds all the elements in the specified collection to the set if they are not already present.
628 <param name="c">A collection of objects to add to the set.</param>
629 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
631 <member name="M:Iesi.Collections.Generic.DictionarySet`1.Clear">
633 Removes all objects from the set.
636 <member name="M:Iesi.Collections.Generic.DictionarySet`1.Contains(`0)">
638 Returns <see langword="true" /> if this set contains the specified element.
640 <param name="o">The element to look for.</param>
641 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
643 <member name="M:Iesi.Collections.Generic.DictionarySet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
645 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
647 <param name="c">A collection of objects.</param>
648 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
650 <member name="M:Iesi.Collections.Generic.DictionarySet`1.Remove(`0)">
652 Removes the specified element from the set.
654 <param name="o">The element to be removed.</param>
655 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
657 <member name="M:Iesi.Collections.Generic.DictionarySet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
659 Remove all the specified elements from this set, if they exist in this set.
661 <param name="c">A collection of elements to remove.</param>
662 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
664 <member name="M:Iesi.Collections.Generic.DictionarySet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
666 Retains only the elements in this set that are contained in the specified collection.
668 <param name="c">Collection that defines the set of elements to be retained.</param>
669 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
671 <member name="M:Iesi.Collections.Generic.DictionarySet`1.CopyTo(`0[],System.Int32)">
673 Copies the elements in the <c>Set</c> to an array of T. The type of array needs
674 to be compatible with the objects in the <c>Set</c>, obviously.
676 <param name="array">An array that will be the target of the copy operation.</param>
677 <param name="index">The zero-based index where copying will start.</param>
679 <member name="M:Iesi.Collections.Generic.DictionarySet`1.GetEnumerator">
681 Gets an enumerator for the elements in the <c>Set</c>.
683 <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
685 <member name="M:Iesi.Collections.Generic.DictionarySet`1.NonGenericCopyTo(System.Array,System.Int32)">
687 Copies the elements in the <c>Set</c> to an array. The type of array needs
688 to be compatible with the objects in the <c>Set</c>, obviously. Needed for
689 non-generic ISet methods implementation
691 <param name="array">An array that will be the target of the copy operation.</param>
692 <param name="index">The zero-based index where copying will start.</param>
694 <member name="P:Iesi.Collections.Generic.DictionarySet`1.Placeholder">
696 The placeholder object used as the value for the <c>IDictionary</c> instance.
699 There is a single instance of this object globally, used for all <c>Sets</c>.
702 <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsEmpty">
704 Returns <see langword="true" /> if this set contains no elements.
707 <member name="P:Iesi.Collections.Generic.DictionarySet`1.Count">
709 The number of elements contained in this collection.
712 <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsSynchronized">
714 None of the objects based on <c>DictionarySet</c> are synchronized. Use the
715 <c>SyncRoot</c> property instead.
718 <member name="P:Iesi.Collections.Generic.DictionarySet`1.SyncRoot">
720 Returns an object that can be used to synchronize the <c>Set</c> between threads.
723 <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsReadOnly">
725 Indicates wether the <c>Set</c> is read-only or not
728 <member name="T:Iesi.Collections.Generic.HashedSet`1">
730 Implements a <c>Set</c> based on a Dictionary (which is equivalent of
731 non-genric <c>HashTable</c>) This will give the best lookup, add, and remove
732 performance for very large data-sets, but iteration will occur in no particular order.
735 <member name="M:Iesi.Collections.Generic.HashedSet`1.#ctor">
737 Creates a new set instance based on a Dictinary.
740 <member name="M:Iesi.Collections.Generic.HashedSet`1.#ctor(System.Collections.Generic.ICollection{`0})">
742 Creates a new set instance based on a Dictinary and
743 initializes it based on a collection of elements.
745 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
747 <member name="T:Iesi.Collections.Generic.ImmutableSet`1">
749 <p>Implements an immutable (read-only) <c>Set</c> wrapper.</p>
750 <p>Although this is advertised as immutable, it really isn't. Anyone with access to the
751 <c>basisSet</c> can still change the data-set. So <c>GetHashCode()</c> is not implemented
752 for this <c>Set</c>, as is the case for all <c>Set</c> implementations in this library.
753 This design decision was based on the efficiency of not having to <c>Clone()</c> the
754 <c>basisSet</c> every time you wrap a mutable <c>Set</c>.</p>
757 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.#ctor(Iesi.Collections.Generic.ISet{`0})">
759 Constructs an immutable (read-only) <c>Set</c> wrapper.
761 <param name="basisSet">The <c>Set</c> that is wrapped.</param>
763 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Add(`0)">
765 Adds the specified element to this set if it is not already present.
767 <param name="o">The object to add to the set.</param>
768 <returns>nothing</returns>
769 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
771 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.AddAll(System.Collections.Generic.ICollection{`0})">
773 Adds all the elements in the specified collection to the set if they are not already present.
775 <param name="c">A collection of objects to add to the set.</param>
776 <returns>nothing</returns>
777 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
779 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Clear">
781 Removes all objects from the set.
783 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
785 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Contains(`0)">
787 Returns <see langword="true" /> if this set contains the specified element.
789 <param name="o">The element to look for.</param>
790 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
792 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
794 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
796 <param name="c">A collection of objects.</param>
797 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
799 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Remove(`0)">
801 Removes the specified element from the set.
803 <param name="o">The element to be removed.</param>
804 <returns>nothing</returns>
805 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
807 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
809 Remove all the specified elements from this set, if they exist in this set.
811 <param name="c">A collection of elements to remove.</param>
812 <returns>nothing</returns>
813 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
815 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
817 Retains only the elements in this set that are contained in the specified collection.
819 <param name="c">Collection that defines the set of elements to be retained.</param>
820 <returns>nothing</returns>
821 <exception cref="T:System.NotSupportedException"> is always thrown</exception>
823 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.CopyTo(`0[],System.Int32)">
825 Copies the elements in the <c>Set</c> to an array of T. The type of array needs
826 to be compatible with the objects in the <c>Set</c>, obviously.
828 <param name="array">An array that will be the target of the copy operation.</param>
829 <param name="index">The zero-based index where copying will start.</param>
831 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.GetEnumerator">
833 Gets an enumerator for the elements in the <c>Set</c>.
835 <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
837 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Clone">
839 Returns a clone of the <c>Set</c> instance.
841 <returns>A clone of this object.</returns>
843 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Union(Iesi.Collections.Generic.ISet{`0})">
845 Performs a "union" of the two sets, where all the elements
846 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
847 Neither this set nor the input set are modified during the operation. The return value
848 is a <c>Clone()</c> of this set with the extra elements added in.
850 <param name="a">A collection of elements.</param>
851 <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
852 Neither of the input objects is modified by the union.</returns>
854 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
856 Performs an "intersection" of the two sets, where only the elements
857 that are present in both sets remain. That is, the element is included if it exists in
858 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
859 a <c>Clone()</c> of this set with the appropriate elements removed.
861 <param name="a">A set of elements.</param>
862 <returns>The intersection of this set with <c>a</c>.</returns>
864 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Minus(Iesi.Collections.Generic.ISet{`0})">
866 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
867 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
868 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
869 of this <c>Set</c> containing the elements from the operation.
871 <param name="a">A set of elements.</param>
872 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
874 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
876 Performs an "exclusive-or" of the two sets, keeping only the elements that
877 are in one of the sets, but not in both. The original sets are not modified
878 during this operation. The result set is a <c>Clone()</c> of this set containing
879 the elements from the exclusive-or operation.
881 <param name="a">A set of elements.</param>
882 <returns>A set containing the result of <c>a ^ b</c>.</returns>
884 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericCopyTo(System.Array,System.Int32)">
886 Performs CopyTo when called trhough non-generic ISet (ICollection) interface
888 <param name="array"></param>
889 <param name="index"></param>
891 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericUnion(Iesi.Collections.ISet)">
893 Performs Union when called trhough non-generic ISet interface
895 <param name="a"></param>
898 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericMinus(Iesi.Collections.ISet)">
900 Performs Minus when called trhough non-generic ISet interface
902 <param name="a"></param>
905 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericIntersect(Iesi.Collections.ISet)">
907 Performs Intersect when called trhough non-generic ISet interface
909 <param name="a"></param>
912 <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericExclusiveOr(Iesi.Collections.ISet)">
914 Performs ExclusiveOr when called trhough non-generic ISet interface
916 <param name="a"></param>
919 <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsEmpty">
921 Returns <see langword="true" /> if this set contains no elements.
924 <member name="P:Iesi.Collections.Generic.ImmutableSet`1.Count">
926 The number of elements contained in this collection.
929 <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsSynchronized">
931 Returns an object that can be used to synchronize use of the <c>Set</c> across threads.
934 <member name="P:Iesi.Collections.Generic.ImmutableSet`1.SyncRoot">
936 Returns an object that can be used to synchronize the <c>Set</c> between threads.
939 <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsReadOnly">
941 Indicates that the given instance is read-only
944 <member name="T:Iesi.Collections.Generic.SortedSet`1">
946 Implements a <c>Set</c> based on a sorted tree. This gives good performance for operations on very
947 large data-sets, though not as good - asymptotically - as a <c>HashedSet</c>. However, iteration
948 occurs in order. Elements that you put into this type of collection must implement <c>IComparable</c>,
949 and they must actually be comparable. You can't mix <c>string</c> and <c>int</c> values, for example.
952 <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor">
954 Creates a new set instance based on a sorted tree.
957 <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.IComparer{`0})">
959 Creates a new set instance based on a sorted tree.
961 <param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1"/> to use for sorting.</param>
963 <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.ICollection{`0})">
965 Creates a new set instance based on a sorted tree and
966 initializes it based on a collection of elements.
968 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
970 <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.ICollection)">
972 Creates a new set instance based on a sorted tree and
973 initializes it based on a collection of elements.
975 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
977 <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.ICollection{`0},System.Collections.Generic.IComparer{`0})">
979 Creates a new set instance based on a sorted tree and
980 initializes it based on a collection of elements.
982 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
983 <param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1"/> to use for sorting.</param>
985 <member name="T:Iesi.Collections.Generic.SynchronizedSet`1">
987 <p>Implements a thread-safe <c>Set</c> wrapper. The implementation is extremely conservative,
988 serializing critical sections to prevent possible deadlocks, and locking on everything.
989 The one exception is for enumeration, which is inherently not thread-safe. For this, you
990 have to <c>lock</c> the <c>SyncRoot</c> object for the duration of the enumeration.</p>
993 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.#ctor(Iesi.Collections.Generic.ISet{`0})">
995 Constructs a thread-safe <c>Set</c> wrapper.
997 <param name="basisSet">The <c>Set</c> object that this object will wrap.</param>
999 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Add(`0)">
1001 Adds the specified element to this set if it is not already present.
1003 <param name="o">The object to add to the set.</param>
1004 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
1006 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.AddAll(System.Collections.Generic.ICollection{`0})">
1008 Adds all the elements in the specified collection to the set if they are not already present.
1010 <param name="c">A collection of objects to add to the set.</param>
1011 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
1013 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Clear">
1015 Removes all objects from the set.
1018 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Contains(`0)">
1020 Returns <see langword="true" /> if this set contains the specified element.
1022 <param name="o">The element to look for.</param>
1023 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
1025 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
1027 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
1029 <param name="c">A collection of objects.</param>
1030 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
1032 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Remove(`0)">
1034 Removes the specified element from the set.
1036 <param name="o">The element to be removed.</param>
1037 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
1039 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
1041 Remove all the specified elements from this set, if they exist in this set.
1043 <param name="c">A collection of elements to remove.</param>
1044 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
1046 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
1048 Retains only the elements in this set that are contained in the specified collection.
1050 <param name="c">Collection that defines the set of elements to be retained.</param>
1051 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
1053 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.CopyTo(`0[],System.Int32)">
1055 Copies the elements in the <c>Set</c> to an array. The type of array needs
1056 to be compatible with the objects in the <c>Set</c>, obviously.
1058 <param name="array">An array that will be the target of the copy operation.</param>
1059 <param name="index">The zero-based index where copying will start.</param>
1061 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.GetEnumerator">
1063 Enumeration is, by definition, not thread-safe. Use a <c>lock</c> on the <c>SyncRoot</c>
1064 to synchronize the entire enumeration process.
1068 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Clone">
1070 Returns a clone of the <c>Set</c> instance.
1072 <returns>A clone of this object.</returns>
1074 <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.NonGenericCopyTo(System.Array,System.Int32)">
1076 Performs CopyTo when called trhough non-generic ISet (ICollection) interface
1078 <param name="array"></param>
1079 <param name="index"></param>
1081 <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsEmpty">
1083 Returns <see langword="true" /> if this set contains no elements.
1086 <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.Count">
1088 The number of elements contained in this collection.
1091 <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsSynchronized">
1093 Returns <see langword="true" />, indicating that this object is thread-safe. The exception to this
1094 is enumeration, which is inherently not thread-safe. Use the <c>SyncRoot</c> object to
1095 lock this object for the entire duration of the enumeration.
1098 <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.SyncRoot">
1100 Returns an object that can be used to synchronize the <c>Set</c> between threads.
1103 <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsReadOnly">
1105 Indicates whether given instace is read-only or not
1108 <member name="T:Iesi.Collections.DictionarySet">
1110 <p><c>DictionarySet</c> is an abstract class that supports the creation of new <c>Set</c>
1111 types where the underlying data store is an <c>IDictionary</c> instance.</p>
1113 <p>You can use any object that implements the <c>IDictionary</c> interface to hold set data.
1114 You can define your own, or you can use one of the objects provided in the Framework.
1115 The type of <c>IDictionary</c> you choose will affect both the performance and the behavior
1116 of the <c>Set</c> using it. </p>
1118 <p>To make a <c>Set</c> typed based on your own <c>IDictionary</c>, simply derive a
1119 new class with a constructor that takes no parameters. Some <c>Set</c> implmentations
1120 cannot be defined with a default constructor. If this is the case for your class,
1121 you will need to override <c>Clone()</c> as well.</p>
1123 <p>It is also standard practice that at least one of your constructors takes an <c>ICollection</c> or
1124 an <c>ISet</c> as an argument.</p>
1127 <member name="T:Iesi.Collections.Set">
1128 <summary>A collection that contains no duplicate elements.</summary>
1131 This class models the mathematical set abstraction, and is the base class for all
1132 other set implementations. The order of elements in a set is dependant on
1133 (a) the data-structure implementation, and (b) the implementation of the various
1134 methods, and thus is not guaranteed.
1137 None of the <see cref="T:Iesi.Collections.ISet"/> implementations in this library are guranteed to be thread-safe
1138 in any way unless wrapped in a <see cref="T:Iesi.Collections.SynchronizedSet"/>.
1141 The following table summarizes the binary operators that are supported by the <see cref="T:Iesi.Collections.ISet"/>
1146 <term>Operation</term>
1147 <term>Description</term>
1149 <term>Operator</term>
1152 <term>Union (OR)</term>
1153 <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
1154 <term><c>Union()</c></term>
1155 <term><c>|</c></term>
1158 <term>Intersection (AND)</term>
1159 <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
1160 <term><c>InterSect()</c></term>
1161 <term><c>&</c></term>
1164 <term>Exclusive Or (XOR)</term>
1165 <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
1166 <term><c>ExclusiveOr()</c></term>
1167 <term><c>^</c></term>
1170 <term>Minus (n/a)</term>
1171 <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
1172 them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
1173 <term><c>Minus()</c></term>
1174 <term><c>-</c></term>
1179 <member name="M:Iesi.Collections.Set.Union(Iesi.Collections.ISet)">
1181 Performs a "union" of the two sets, where all the elements
1182 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
1183 Neither this set nor the input set are modified during the operation. The return value
1184 is a clone of this set with the extra elements added in.
1186 <param name="a">A collection of elements.</param>
1187 <returns>A new <see cref="T:Iesi.Collections.ISet"/> instance containing the union of this instance with the specified collection.
1188 Neither of the input objects is modified by the union.</returns>
1190 <member name="M:Iesi.Collections.Set.Union(Iesi.Collections.ISet,Iesi.Collections.ISet)">
1192 Performs a "union" of two sets, where all the elements
1193 in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
1194 The return value is a clone of one of the sets (<c>a</c> if it is not <see langword="null" />) with elements of the other set
1195 added in. Neither of the input sets is modified by the operation.
1197 <param name="a">A set of elements.</param>
1198 <param name="b">A set of elements.</param>
1199 <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1201 <member name="M:Iesi.Collections.Set.op_BitwiseOr(Iesi.Collections.Set,Iesi.Collections.Set)">
1203 Performs a "union" of two sets, where all the elements
1204 in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
1205 The return value is a clone of one of the sets (<c>a</c> if it is not <see langword="null" />) with elements of the other set
1206 added in. Neither of the input sets is modified by the operation.
1208 <param name="a">A set of elements.</param>
1209 <param name="b">A set of elements.</param>
1210 <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1212 <member name="M:Iesi.Collections.Set.Intersect(Iesi.Collections.ISet)">
1214 Performs an "intersection" of the two sets, where only the elements
1215 that are present in both sets remain. That is, the element is included if it exists in
1216 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
1217 a <c>Clone()</c> of this set with the appropriate elements removed.
1219 <param name="a">A set of elements.</param>
1220 <returns>The intersection of this set with <c>a</c>.</returns>
1222 <member name="M:Iesi.Collections.Set.Intersect(Iesi.Collections.ISet,Iesi.Collections.ISet)">
1224 Performs an "intersection" of the two sets, where only the elements
1225 that are present in both sets remain. That is, the element is included only if it exists in
1226 both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
1227 The result object is a <c>Clone()</c> of one of the input objects (<c>a</c> if it is not <see langword="null" />) containing the
1228 elements from the intersect operation.
1230 <param name="a">A set of elements.</param>
1231 <param name="b">A set of elements.</param>
1232 <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1234 <member name="M:Iesi.Collections.Set.op_BitwiseAnd(Iesi.Collections.Set,Iesi.Collections.Set)">
1236 Performs an "intersection" of the two sets, where only the elements
1237 that are present in both sets remain. That is, the element is included only if it exists in
1238 both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
1239 The result object is a <c>Clone()</c> of one of the input objects (<c>a</c> if it is not <see langword="null" />) containing the
1240 elements from the intersect operation.
1242 <param name="a">A set of elements.</param>
1243 <param name="b">A set of elements.</param>
1244 <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1246 <member name="M:Iesi.Collections.Set.Minus(Iesi.Collections.ISet)">
1248 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
1249 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
1250 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
1251 of this <c>Set</c> containing the elements from the operation.
1253 <param name="a">A set of elements.</param>
1254 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
1256 <member name="M:Iesi.Collections.Set.Minus(Iesi.Collections.ISet,Iesi.Collections.ISet)">
1258 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
1259 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
1260 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
1261 of set <c>a</c> containing the elements from the operation.
1263 <param name="a">A set of elements.</param>
1264 <param name="b">A set of elements.</param>
1265 <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
1267 <member name="M:Iesi.Collections.Set.op_Subtraction(Iesi.Collections.Set,Iesi.Collections.Set)">
1269 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
1270 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
1271 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
1272 of set <c>a</c> containing the elements from the operation.
1274 <param name="a">A set of elements.</param>
1275 <param name="b">A set of elements.</param>
1276 <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
1278 <member name="M:Iesi.Collections.Set.ExclusiveOr(Iesi.Collections.ISet)">
1280 Performs an "exclusive-or" of the two sets, keeping only the elements that
1281 are in one of the sets, but not in both. The original sets are not modified
1282 during this operation. The result set is a clone of this set containing
1283 the elements from the exclusive-or operation.
1285 <param name="a">A set of elements.</param>
1286 <returns>A set containing the result of <c>a ^ b</c>.</returns>
1288 <member name="M:Iesi.Collections.Set.ExclusiveOr(Iesi.Collections.ISet,Iesi.Collections.ISet)">
1290 Performs an "exclusive-or" of the two sets, keeping only the elements that
1291 are in one of the sets, but not in both. The original sets are not modified
1292 during this operation. The result set is a clone of one of the sets
1293 (<c>a</c> if it is not <see langword="null" />) containing
1294 the elements from the exclusive-or operation.
1296 <param name="a">A set of elements.</param>
1297 <param name="b">A set of elements.</param>
1298 <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1300 <member name="M:Iesi.Collections.Set.op_ExclusiveOr(Iesi.Collections.Set,Iesi.Collections.Set)">
1302 Performs an "exclusive-or" of the two sets, keeping only the elements that
1303 are in one of the sets, but not in both. The original sets are not modified
1304 during this operation. The result set is a clone of one of the sets
1305 (<c>a</c> if it is not <see langword="null" />) containing
1306 the elements from the exclusive-or operation.
1308 <param name="a">A set of elements.</param>
1309 <param name="b">A set of elements.</param>
1310 <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
1312 <member name="M:Iesi.Collections.Set.Add(System.Object)">
1314 Adds the specified element to this set if it is not already present.
1316 <param name="o">The object to add to the set.</param>
1317 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
1319 <member name="M:Iesi.Collections.Set.AddAll(System.Collections.ICollection)">
1321 Adds all the elements in the specified collection to the set if they are not already present.
1323 <param name="c">A collection of objects to add to the set.</param>
1324 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
1326 <member name="M:Iesi.Collections.Set.Clear">
1328 Removes all objects from the set.
1331 <member name="M:Iesi.Collections.Set.Contains(System.Object)">
1333 Returns <see langword="true" /> if this set contains the specified element.
1335 <param name="o">The element to look for.</param>
1336 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
1338 <member name="M:Iesi.Collections.Set.ContainsAll(System.Collections.ICollection)">
1340 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
1342 <param name="c">A collection of objects.</param>
1343 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
1345 <member name="M:Iesi.Collections.Set.Remove(System.Object)">
1347 Removes the specified element from the set.
1349 <param name="o">The element to be removed.</param>
1350 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
1352 <member name="M:Iesi.Collections.Set.RemoveAll(System.Collections.ICollection)">
1354 Remove all the specified elements from this set, if they exist in this set.
1356 <param name="c">A collection of elements to remove.</param>
1357 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
1359 <member name="M:Iesi.Collections.Set.RetainAll(System.Collections.ICollection)">
1361 Retains only the elements in this set that are contained in the specified collection.
1363 <param name="c">Collection that defines the set of elements to be retained.</param>
1364 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
1366 <member name="M:Iesi.Collections.Set.Clone">
1368 Returns a clone of the set instance. This will work for derived set
1369 classes if the derived class implements a constructor that takes no arguments.
1371 <returns>A clone of this object.</returns>
1373 <member name="M:Iesi.Collections.Set.CopyTo(System.Array,System.Int32)">
1375 Copies the elements in the set to an array. The type of array needs
1376 to be compatible with the objects in the set, obviously.
1378 <param name="array">An array that will be the target of the copy operation.</param>
1379 <param name="index">The zero-based index where copying will start.</param>
1381 <member name="M:Iesi.Collections.Set.GetEnumerator">
1383 Returns an enumerator that iterates through the set.
1386 An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the set.
1389 <member name="P:Iesi.Collections.Set.IsEmpty">
1391 Returns <see langword="true" /> if this set contains no elements.
1394 <member name="P:Iesi.Collections.Set.Count">
1396 The number of elements currently contained in this collection.
1399 <member name="P:Iesi.Collections.Set.IsSynchronized">
1401 Returns <see langword="true"/> if the set is synchronized across threads. Note that
1402 enumeration is inherently not thread-safe. Use the <see cref="P:Iesi.Collections.Set.SyncRoot"/> to lock the
1403 object during enumeration.
1406 <member name="P:Iesi.Collections.Set.SyncRoot">
1408 An object that can be used to synchronize this collection to make it thread-safe.
1409 When implementing this, if your object uses a base object, like an <see cref="T:System.Collections.IDictionary"/>,
1410 or anything that has a <see cref="P:Iesi.Collections.Set.SyncRoot"/>, return that object instead
1411 of <see langword="this"/>.
1414 <member name="F:Iesi.Collections.DictionarySet.InternalDictionary">
1416 Provides the storage for elements in the <c>Set</c>, stored as the key-set
1417 of the <c>IDictionary</c> object. Set this object in the constructor
1418 if you create your own <c>Set</c> class.
1421 <member name="M:Iesi.Collections.DictionarySet.Add(System.Object)">
1423 Adds the specified element to this set if it is not already present.
1425 <param name="o">The object to add to the set.</param>
1426 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
1428 <member name="M:Iesi.Collections.DictionarySet.AddAll(System.Collections.ICollection)">
1430 Adds all the elements in the specified collection to the set if they are not already present.
1432 <param name="c">A collection of objects to add to the set.</param>
1433 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
1435 <member name="M:Iesi.Collections.DictionarySet.Clear">
1437 Removes all objects from the set.
1440 <member name="M:Iesi.Collections.DictionarySet.Contains(System.Object)">
1442 Returns <see langword="true" /> if this set contains the specified element.
1444 <param name="o">The element to look for.</param>
1445 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
1447 <member name="M:Iesi.Collections.DictionarySet.ContainsAll(System.Collections.ICollection)">
1449 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
1451 <param name="c">A collection of objects.</param>
1452 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
1454 <member name="M:Iesi.Collections.DictionarySet.Remove(System.Object)">
1456 Removes the specified element from the set.
1458 <param name="o">The element to be removed.</param>
1459 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
1461 <member name="M:Iesi.Collections.DictionarySet.RemoveAll(System.Collections.ICollection)">
1463 Remove all the specified elements from this set, if they exist in this set.
1465 <param name="c">A collection of elements to remove.</param>
1466 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
1468 <member name="M:Iesi.Collections.DictionarySet.RetainAll(System.Collections.ICollection)">
1470 Retains only the elements in this set that are contained in the specified collection.
1472 <param name="c">Collection that defines the set of elements to be retained.</param>
1473 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
1475 <member name="M:Iesi.Collections.DictionarySet.CopyTo(System.Array,System.Int32)">
1477 Copies the elements in the <c>Set</c> to an array. The type of array needs
1478 to be compatible with the objects in the <c>Set</c>, obviously.
1480 <param name="array">An array that will be the target of the copy operation.</param>
1481 <param name="index">The zero-based index where copying will start.</param>
1483 <member name="M:Iesi.Collections.DictionarySet.GetEnumerator">
1485 Gets an enumerator for the elements in the <c>Set</c>.
1487 <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
1489 <member name="P:Iesi.Collections.DictionarySet.Placeholder">
1491 The placeholder object used as the value for the <c>IDictionary</c> instance.
1494 There is a single instance of this object globally, used for all <c>Sets</c>.
1497 <member name="P:Iesi.Collections.DictionarySet.IsEmpty">
1499 Returns <see langword="true" /> if this set contains no elements.
1502 <member name="P:Iesi.Collections.DictionarySet.Count">
1504 The number of elements contained in this collection.
1507 <member name="P:Iesi.Collections.DictionarySet.IsSynchronized">
1509 None of the objects based on <c>DictionarySet</c> are synchronized. Use the
1510 <c>SyncRoot</c> property instead.
1513 <member name="P:Iesi.Collections.DictionarySet.SyncRoot">
1515 Returns an object that can be used to synchronize the <c>Set</c> between threads.
1518 <member name="T:Iesi.Collections.HashedSet">
1520 Implements a <c>Set</c> based on a hash table. This will give the best lookup, add, and remove
1521 performance for very large data-sets, but iteration will occur in no particular order.
1524 <member name="M:Iesi.Collections.HashedSet.#ctor">
1526 Creates a new set instance based on a hash table.
1529 <member name="M:Iesi.Collections.HashedSet.#ctor(System.Collections.ICollection)">
1531 Creates a new set instance based on a hash table and
1532 initializes it based on a collection of elements.
1534 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
1536 <member name="T:Iesi.Collections.HybridSet">
1538 Implements a <c>Set</c> that automatically changes from a list to a hash table
1539 when the size reaches a certain threshold. This is good if you are unsure about
1540 whether you data-set will be tiny or huge. Because this uses a dual implementation,
1541 iteration order is not guaranteed!
1544 <member name="M:Iesi.Collections.HybridSet.#ctor">
1546 Creates a new set instance based on either a list or a hash table, depending on which
1547 will be more efficient based on the data-set size.
1550 <member name="M:Iesi.Collections.HybridSet.#ctor(System.Collections.ICollection)">
1552 Creates a new set instance based on either a list or a hash table, depending on which
1553 will be more efficient based on the data-set size, and
1554 initializes it based on a collection of elements.
1556 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
1558 <member name="T:Iesi.Collections.ImmutableSet">
1560 <p>Implements an immutable (read-only) <c>Set</c> wrapper.</p>
1561 <p>Although this is advertised as immutable, it really isn't. Anyone with access to the
1562 <c>basisSet</c> can still change the data-set. So <c>GetHashCode()</c> is not implemented
1563 for this <c>Set</c>, as is the case for all <c>Set</c> implementations in this library.
1564 This design decision was based on the efficiency of not having to <c>Clone()</c> the
1565 <c>basisSet</c> every time you wrap a mutable <c>Set</c>.</p>
1568 <member name="M:Iesi.Collections.ImmutableSet.#ctor(Iesi.Collections.ISet)">
1570 Constructs an immutable (read-only) <c>Set</c> wrapper.
1572 <param name="basisSet">The <c>Set</c> that is wrapped.</param>
1574 <member name="M:Iesi.Collections.ImmutableSet.Add(System.Object)">
1576 Adds the specified element to this set if it is not already present.
1578 <param name="o">The object to add to the set.</param>
1579 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
1581 <member name="M:Iesi.Collections.ImmutableSet.AddAll(System.Collections.ICollection)">
1583 Adds all the elements in the specified collection to the set if they are not already present.
1585 <param name="c">A collection of objects to add to the set.</param>
1586 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
1588 <member name="M:Iesi.Collections.ImmutableSet.Clear">
1590 Removes all objects from the set.
1593 <member name="M:Iesi.Collections.ImmutableSet.Contains(System.Object)">
1595 Returns <see langword="true" /> if this set contains the specified element.
1597 <param name="o">The element to look for.</param>
1598 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
1600 <member name="M:Iesi.Collections.ImmutableSet.ContainsAll(System.Collections.ICollection)">
1602 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
1604 <param name="c">A collection of objects.</param>
1605 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
1607 <member name="M:Iesi.Collections.ImmutableSet.Remove(System.Object)">
1609 Removes the specified element from the set.
1611 <param name="o">The element to be removed.</param>
1612 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
1614 <member name="M:Iesi.Collections.ImmutableSet.RemoveAll(System.Collections.ICollection)">
1616 Remove all the specified elements from this set, if they exist in this set.
1618 <param name="c">A collection of elements to remove.</param>
1619 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
1621 <member name="M:Iesi.Collections.ImmutableSet.RetainAll(System.Collections.ICollection)">
1623 Retains only the elements in this set that are contained in the specified collection.
1625 <param name="c">Collection that defines the set of elements to be retained.</param>
1626 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
1628 <member name="M:Iesi.Collections.ImmutableSet.CopyTo(System.Array,System.Int32)">
1630 Copies the elements in the <c>Set</c> to an array. The type of array needs
1631 to be compatible with the objects in the <c>Set</c>, obviously.
1633 <param name="array">An array that will be the target of the copy operation.</param>
1634 <param name="index">The zero-based index where copying will start.</param>
1636 <member name="M:Iesi.Collections.ImmutableSet.GetEnumerator">
1638 Gets an enumerator for the elements in the <c>Set</c>.
1640 <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
1642 <member name="M:Iesi.Collections.ImmutableSet.Clone">
1644 Returns a clone of the <c>Set</c> instance.
1646 <returns>A clone of this object.</returns>
1648 <member name="M:Iesi.Collections.ImmutableSet.Union(Iesi.Collections.ISet)">
1650 Performs a "union" of the two sets, where all the elements
1651 in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
1652 Neither this set nor the input set are modified during the operation. The return value
1653 is a <c>Clone()</c> of this set with the extra elements added in.
1655 <param name="a">A collection of elements.</param>
1656 <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
1657 Neither of the input objects is modified by the union.</returns>
1659 <member name="M:Iesi.Collections.ImmutableSet.Intersect(Iesi.Collections.ISet)">
1661 Performs an "intersection" of the two sets, where only the elements
1662 that are present in both sets remain. That is, the element is included if it exists in
1663 both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
1664 a <c>Clone()</c> of this set with the appropriate elements removed.
1666 <param name="a">A set of elements.</param>
1667 <returns>The intersection of this set with <c>a</c>.</returns>
1669 <member name="M:Iesi.Collections.ImmutableSet.Minus(Iesi.Collections.ISet)">
1671 Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
1672 the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
1673 The original sets are not modified during this operation. The result set is a <c>Clone()</c>
1674 of this <c>Set</c> containing the elements from the operation.
1676 <param name="a">A set of elements.</param>
1677 <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
1679 <member name="M:Iesi.Collections.ImmutableSet.ExclusiveOr(Iesi.Collections.ISet)">
1681 Performs an "exclusive-or" of the two sets, keeping only the elements that
1682 are in one of the sets, but not in both. The original sets are not modified
1683 during this operation. The result set is a <c>Clone()</c> of this set containing
1684 the elements from the exclusive-or operation.
1686 <param name="a">A set of elements.</param>
1687 <returns>A set containing the result of <c>a ^ b</c>.</returns>
1689 <member name="P:Iesi.Collections.ImmutableSet.IsEmpty">
1691 Returns <see langword="true" /> if this set contains no elements.
1694 <member name="P:Iesi.Collections.ImmutableSet.Count">
1696 The number of elements contained in this collection.
1699 <member name="P:Iesi.Collections.ImmutableSet.IsSynchronized">
1701 Returns an object that can be used to synchronize use of the <c>Set</c> across threads.
1704 <member name="P:Iesi.Collections.ImmutableSet.SyncRoot">
1706 Returns an object that can be used to synchronize the <c>Set</c> between threads.
1709 <member name="T:Iesi.Collections.ListSet">
1711 Implements a <c>Set</c> based on a list. Performance is much better for very small lists
1712 than either <c>HashedSet</c> or <c>SortedSet</c>. However, performance degrades rapidly as
1713 the data-set gets bigger. Use a <c>HybridSet</c> instead if you are not sure your data-set
1714 will always remain very small. Iteration produces elements in the order they were added.
1715 However, element order is not guaranteed to be maintained by the various <c>Set</c>
1716 mathematical operators.
1719 <member name="M:Iesi.Collections.ListSet.#ctor">
1721 Creates a new set instance based on a list.
1724 <member name="M:Iesi.Collections.ListSet.#ctor(System.Collections.ICollection)">
1726 Creates a new set instance based on a list and
1727 initializes it based on a collection of elements.
1729 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
1731 <member name="T:Iesi.Collections.SortedSet">
1733 Implements a set based on a sorted tree. This gives good performance for operations on very
1734 large data-sets, though not as good - asymptotically - as a <see cref="T:Iesi.Collections.HashedSet"/>.
1735 However, iteration occurs in order. Elements that you put into this type of collection must
1736 implement <see cref="T:System.IComparable"/>, and they must actually be comparable. You can't mix
1737 <see cref="T:System.String"/> and <see cref="T:System.Int32"/> values, for example.
1740 <member name="M:Iesi.Collections.SortedSet.#ctor">
1742 Creates a new set instance based on a sorted tree.
1745 <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.IComparer)">
1747 Creates a new set instance based on a sorted tree.
1749 <param name="comparer">The <see cref="T:System.Collections.IComparer"/> to use for sorting.</param>
1751 <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.ICollection)">
1753 Creates a new set instance based on a sorted tree and
1754 initializes it based on a collection of elements.
1756 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
1758 <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.ICollection,System.Collections.IComparer)">
1760 Creates a new set instance based on a sorted tree and
1761 initializes it based on a collection of elements.
1763 <param name="initialValues">A collection of elements that defines the initial set contents.</param>
1764 <param name="comparer">The <see cref="T:System.Collections.IComparer"/> to use for sorting.</param>
1766 <member name="T:Iesi.Collections.SynchronizedSet">
1768 Implements a thread-safe <see cref="T:Iesi.Collections.ISet"/> wrapper.
1771 The implementation is extremely conservative, serializing critical sections
1772 to prevent possible deadlocks, and locking on everything. The one exception
1773 is for enumeration, which is inherently not thread-safe. For this, you have
1774 to <see langword="lock"/> the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/> object for the duration
1778 <member name="M:Iesi.Collections.SynchronizedSet.#ctor(Iesi.Collections.ISet)">
1780 Constructs a thread-safe <see cref="T:Iesi.Collections.ISet"/> wrapper.
1782 <param name="basisSet">The <see cref="T:Iesi.Collections.ISet"/> object that this object will wrap.</param>
1784 <member name="M:Iesi.Collections.SynchronizedSet.Add(System.Object)">
1786 Adds the specified element to this set if it is not already present.
1788 <param name="o">The object to add to the set.</param>
1789 <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
1791 <member name="M:Iesi.Collections.SynchronizedSet.AddAll(System.Collections.ICollection)">
1793 Adds all the elements in the specified collection to the set if they are not already present.
1795 <param name="c">A collection of objects to add to the set.</param>
1796 <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
1798 <member name="M:Iesi.Collections.SynchronizedSet.Clear">
1800 Removes all objects from the set.
1803 <member name="M:Iesi.Collections.SynchronizedSet.Contains(System.Object)">
1805 Returns <see langword="true" /> if this set contains the specified element.
1807 <param name="o">The element to look for.</param>
1808 <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
1810 <member name="M:Iesi.Collections.SynchronizedSet.ContainsAll(System.Collections.ICollection)">
1812 Returns <see langword="true" /> if the set contains all the elements in the specified collection.
1814 <param name="c">A collection of objects.</param>
1815 <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
1817 <member name="M:Iesi.Collections.SynchronizedSet.Remove(System.Object)">
1819 Removes the specified element from the set.
1821 <param name="o">The element to be removed.</param>
1822 <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
1824 <member name="M:Iesi.Collections.SynchronizedSet.RemoveAll(System.Collections.ICollection)">
1826 Remove all the specified elements from this set, if they exist in this set.
1828 <param name="c">A collection of elements to remove.</param>
1829 <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
1831 <member name="M:Iesi.Collections.SynchronizedSet.RetainAll(System.Collections.ICollection)">
1833 Retains only the elements in this set that are contained in the specified collection.
1835 <param name="c">Collection that defines the set of elements to be retained.</param>
1836 <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
1838 <member name="M:Iesi.Collections.SynchronizedSet.CopyTo(System.Array,System.Int32)">
1840 Copies the elements in the set to an array. The type of array needs
1841 to be compatible with the objects in the set, obviously.
1843 <param name="array">An array that will be the target of the copy operation.</param>
1844 <param name="index">The zero-based index where copying will start.</param>
1846 <member name="M:Iesi.Collections.SynchronizedSet.GetEnumerator">
1848 Returns an enumerator that iterates through the set.
1851 An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the set.
1854 Enumeration is, by definition, not thread-safe. Use a <see langword="lock"/> on the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/>
1855 to synchronize the entire enumeration process.
1858 <member name="M:Iesi.Collections.SynchronizedSet.Clone">
1860 Returns a clone of this instance.
1862 <returns>A clone of this object.</returns>
1864 <member name="P:Iesi.Collections.SynchronizedSet.IsEmpty">
1866 Returns <see langword="true" /> if this set contains no elements.
1869 <member name="P:Iesi.Collections.SynchronizedSet.Count">
1871 The number of elements contained in this collection.
1874 <member name="P:Iesi.Collections.SynchronizedSet.IsSynchronized">
1876 Returns <see langword="true"/>, indicating that this object is thread-safe. The exception to this
1877 is enumeration, which is inherently not thread-safe. Use the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/> object to
1878 lock this object for the entire duration of the enumeration.
1881 <member name="P:Iesi.Collections.SynchronizedSet.SyncRoot">
1883 Returns an object that can be used to synchronize the set between threads.