No Description

Iesi.Collections.xml 110KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Iesi.Collections</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Iesi.Collections.Generic.DictionarySet`1">
  8. <summary>
  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>
  11. <p>You can use any object that implements the <c>IDictionary</c> interface to hold set data.
  12. You can define your own, or you can use one of the objects provided in the Framework.
  13. The type of <c>IDictionary</c> you choose will affect both the performance and the behavior
  14. of the <c>Set</c> using it. </p>
  15. <p>To make a <c>Set</c> typed based on your own <c>IDictionary</c>, simply derive a
  16. new class with a constructor that takes no parameters. Some <c>Set</c> implmentations
  17. cannot be defined with a default constructor. If this is the case for your class,
  18. you will need to override <c>Clone()</c> as well.</p>
  19. <p>It is also standard practice that at least one of your constructors takes an <c>ICollection</c> or
  20. an <c>ISet</c> as an argument.</p>
  21. </summary>
  22. </member>
  23. <member name="T:Iesi.Collections.Generic.Set`1">
  24. <summary><p>A collection that contains no duplicate elements. This class models the mathematical
  25. <c>Set</c> abstraction, and is the base class for all other <c>Set</c> implementations.
  26. The order of elements in a set is dependant on (a)the data-structure implementation, and
  27. (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
  28. <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
  29. in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
  30. <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
  31. <list type="table">
  32. <listheader>
  33. <term>Operation</term>
  34. <term>Description</term>
  35. <term>Method</term>
  36. <term>Operator</term>
  37. </listheader>
  38. <item>
  39. <term>Union (OR)</term>
  40. <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
  41. <term><c>Union()</c></term>
  42. <term><c>|</c></term>
  43. </item>
  44. <item>
  45. <term>Intersection (AND)</term>
  46. <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
  47. <term><c>InterSect()</c></term>
  48. <term><c>&amp;</c></term>
  49. </item>
  50. <item>
  51. <term>Exclusive Or (XOR)</term>
  52. <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
  53. <term><c>ExclusiveOr()</c></term>
  54. <term><c>^</c></term>
  55. </item>
  56. <item>
  57. <term>Minus (n/a)</term>
  58. <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
  59. them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
  60. <term><c>Minus()</c></term>
  61. <term><c>-</c></term>
  62. </item>
  63. </list>
  64. </summary>
  65. </member>
  66. <member name="T:Iesi.Collections.Generic.ISet`1">
  67. <summary>
  68. <p>A collection that contains no duplicate elements. This interface models the mathematical
  69. <c>Set</c> abstraction.
  70. The order of elements in a set is dependant on (a)the data-structure implementation, and
  71. (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
  72. <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
  73. in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
  74. <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
  75. <list type="table">
  76. <listheader>
  77. <term>Operation</term>
  78. <term>Description</term>
  79. <term>Method</term>
  80. </listheader>
  81. <item>
  82. <term>Union (OR)</term>
  83. <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
  84. <term><c>Union()</c></term>
  85. </item>
  86. <item>
  87. <term>Intersection (AND)</term>
  88. <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
  89. <term><c>InterSect()</c></term>
  90. </item>
  91. <item>
  92. <term>Exclusive Or (XOR)</term>
  93. <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
  94. <term><c>ExclusiveOr()</c></term>
  95. </item>
  96. <item>
  97. <term>Minus (n/a)</term>
  98. <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
  99. them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
  100. <term><c>Minus()</c></term>
  101. </item>
  102. </list>
  103. </summary>
  104. </member>
  105. <member name="M:Iesi.Collections.Generic.ISet`1.Union(Iesi.Collections.Generic.ISet{`0})">
  106. <summary>
  107. Performs a "union" of the two sets, where all the elements
  108. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  109. Neither this set nor the input set are modified during the operation. The return value
  110. is a <c>Clone()</c> of this set with the extra elements added in.
  111. </summary>
  112. <param name="a">A collection of elements.</param>
  113. <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
  114. Neither of the input objects is modified by the union.</returns>
  115. </member>
  116. <member name="M:Iesi.Collections.Generic.ISet`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
  117. <summary>
  118. Performs an "intersection" of the two sets, where only the elements
  119. that are present in both sets remain. That is, the element is included if it exists in
  120. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  121. a <c>Clone()</c> of this set with the appropriate elements removed.
  122. </summary>
  123. <param name="a">A set of elements.</param>
  124. <returns>The intersection of this set with <c>a</c>.</returns>
  125. </member>
  126. <member name="M:Iesi.Collections.Generic.ISet`1.Minus(Iesi.Collections.Generic.ISet{`0})">
  127. <summary>
  128. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  129. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  130. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  131. of this <c>Set</c> containing the elements from the operation.
  132. </summary>
  133. <param name="a">A set of elements.</param>
  134. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  135. </member>
  136. <member name="M:Iesi.Collections.Generic.ISet`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
  137. <summary>
  138. Performs an "exclusive-or" of the two sets, keeping only the elements that
  139. are in one of the sets, but not in both. The original sets are not modified
  140. during this operation. The result set is a <c>Clone()</c> of this set containing
  141. the elements from the exclusive-or operation.
  142. </summary>
  143. <param name="a">A set of elements.</param>
  144. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  145. </member>
  146. <member name="M:Iesi.Collections.Generic.ISet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
  147. <summary>
  148. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  149. </summary>
  150. <param name="c">A collection of objects.</param>
  151. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  152. </member>
  153. <member name="M:Iesi.Collections.Generic.ISet`1.Add(`0)">
  154. <summary>
  155. Adds the specified element to this set if it is not already present.
  156. </summary>
  157. <param name="o">The object to add to the set.</param>
  158. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  159. </member>
  160. <member name="M:Iesi.Collections.Generic.ISet`1.AddAll(System.Collections.Generic.ICollection{`0})">
  161. <summary>
  162. Adds all the elements in the specified collection to the set if they are not already present.
  163. </summary>
  164. <param name="c">A collection of objects to add to the set.</param>
  165. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  166. </member>
  167. <member name="M:Iesi.Collections.Generic.ISet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
  168. <summary>
  169. Remove all the specified elements from this set, if they exist in this set.
  170. </summary>
  171. <param name="c">A collection of elements to remove.</param>
  172. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  173. </member>
  174. <member name="M:Iesi.Collections.Generic.ISet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
  175. <summary>
  176. Retains only the elements in this set that are contained in the specified collection.
  177. </summary>
  178. <param name="c">Collection that defines the set of elements to be retained.</param>
  179. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  180. </member>
  181. <member name="P:Iesi.Collections.Generic.ISet`1.IsEmpty">
  182. <summary>
  183. Returns <see langword="true" /> if this set contains no elements.
  184. </summary>
  185. </member>
  186. <member name="T:Iesi.Collections.ISet">
  187. <summary>
  188. <p>A collection that contains no duplicate elements. This interface models the mathematical
  189. <c>Set</c> abstraction.
  190. The order of elements in a set is dependant on (a)the data-structure implementation, and
  191. (b)the implementation of the various <c>Set</c> methods, and thus is not guaranteed.</p>
  192. <p>None of the <c>Set</c> implementations in this library are guranteed to be thread-safe
  193. in any way unless wrapped in a <c>SynchronizedSet</c>.</p>
  194. <p>The following table summarizes the binary operators that are supported by the <c>Set</c> class.</p>
  195. <list type="table">
  196. <listheader>
  197. <term>Operation</term>
  198. <term>Description</term>
  199. <term>Method</term>
  200. </listheader>
  201. <item>
  202. <term>Union (OR)</term>
  203. <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
  204. <term><c>Union()</c></term>
  205. </item>
  206. <item>
  207. <term>Intersection (AND)</term>
  208. <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
  209. <term><c>InterSect()</c></term>
  210. </item>
  211. <item>
  212. <term>Exclusive Or (XOR)</term>
  213. <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
  214. <term><c>ExclusiveOr()</c></term>
  215. </item>
  216. <item>
  217. <term>Minus (n/a)</term>
  218. <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
  219. them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
  220. <term><c>Minus()</c></term>
  221. </item>
  222. </list>
  223. </summary>
  224. </member>
  225. <member name="M:Iesi.Collections.ISet.Union(Iesi.Collections.ISet)">
  226. <summary>
  227. Performs a "union" of the two sets, where all the elements
  228. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  229. Neither this set nor the input set are modified during the operation. The return value
  230. is a <c>Clone()</c> of this set with the extra elements added in.
  231. </summary>
  232. <param name="a">A collection of elements.</param>
  233. <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
  234. Neither of the input objects is modified by the union.</returns>
  235. </member>
  236. <member name="M:Iesi.Collections.ISet.Intersect(Iesi.Collections.ISet)">
  237. <summary>
  238. Performs an "intersection" of the two sets, where only the elements
  239. that are present in both sets remain. That is, the element is included if it exists in
  240. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  241. a <c>Clone()</c> of this set with the appropriate elements removed.
  242. </summary>
  243. <param name="a">A set of elements.</param>
  244. <returns>The intersection of this set with <c>a</c>.</returns>
  245. </member>
  246. <member name="M:Iesi.Collections.ISet.Minus(Iesi.Collections.ISet)">
  247. <summary>
  248. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  249. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  250. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  251. of this <c>Set</c> containing the elements from the operation.
  252. </summary>
  253. <param name="a">A set of elements.</param>
  254. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  255. </member>
  256. <member name="M:Iesi.Collections.ISet.ExclusiveOr(Iesi.Collections.ISet)">
  257. <summary>
  258. Performs an "exclusive-or" of the two sets, keeping only the elements that
  259. are in one of the sets, but not in both. The original sets are not modified
  260. during this operation. The result set is a <c>Clone()</c> of this set containing
  261. the elements from the exclusive-or operation.
  262. </summary>
  263. <param name="a">A set of elements.</param>
  264. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  265. </member>
  266. <member name="M:Iesi.Collections.ISet.Contains(System.Object)">
  267. <summary>
  268. Returns <see langword="true" /> if this set contains the specified element.
  269. </summary>
  270. <param name="o">The element to look for.</param>
  271. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  272. </member>
  273. <member name="M:Iesi.Collections.ISet.ContainsAll(System.Collections.ICollection)">
  274. <summary>
  275. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  276. </summary>
  277. <param name="c">A collection of objects.</param>
  278. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  279. </member>
  280. <member name="M:Iesi.Collections.ISet.Add(System.Object)">
  281. <summary>
  282. Adds the specified element to this set if it is not already present.
  283. </summary>
  284. <param name="o">The object to add to the set.</param>
  285. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  286. </member>
  287. <member name="M:Iesi.Collections.ISet.AddAll(System.Collections.ICollection)">
  288. <summary>
  289. Adds all the elements in the specified collection to the set if they are not already present.
  290. </summary>
  291. <param name="c">A collection of objects to add to the set.</param>
  292. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  293. </member>
  294. <member name="M:Iesi.Collections.ISet.Remove(System.Object)">
  295. <summary>
  296. Removes the specified element from the set.
  297. </summary>
  298. <param name="o">The element to be removed.</param>
  299. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  300. </member>
  301. <member name="M:Iesi.Collections.ISet.RemoveAll(System.Collections.ICollection)">
  302. <summary>
  303. Remove all the specified elements from this set, if they exist in this set.
  304. </summary>
  305. <param name="c">A collection of elements to remove.</param>
  306. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  307. </member>
  308. <member name="M:Iesi.Collections.ISet.RetainAll(System.Collections.ICollection)">
  309. <summary>
  310. Retains only the elements in this set that are contained in the specified collection.
  311. </summary>
  312. <param name="c">Collection that defines the set of elements to be retained.</param>
  313. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  314. </member>
  315. <member name="M:Iesi.Collections.ISet.Clear">
  316. <summary>
  317. Removes all objects from the set.
  318. </summary>
  319. </member>
  320. <member name="P:Iesi.Collections.ISet.IsEmpty">
  321. <summary>
  322. Returns <see langword="true" /> if this set contains no elements.
  323. </summary>
  324. </member>
  325. <member name="M:Iesi.Collections.Generic.Set`1.Union(Iesi.Collections.Generic.ISet{`0})">
  326. <summary>
  327. Performs a "union" of the two sets, where all the elements
  328. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  329. Neither this set nor the input set are modified during the operation. The return value
  330. is a <c>Clone()</c> of this set with the extra elements added in.
  331. </summary>
  332. <param name="a">A collection of elements.</param>
  333. <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
  334. Neither of the input objects is modified by the union.</returns>
  335. </member>
  336. <member name="M:Iesi.Collections.Generic.Set`1.Union(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
  337. <summary>
  338. Performs a "union" of two sets, where all the elements
  339. in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  340. 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
  341. added in. Neither of the input sets is modified by the operation.
  342. </summary>
  343. <param name="a">A set of elements.</param>
  344. <param name="b">A set of elements.</param>
  345. <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  346. </member>
  347. <member name="M:Iesi.Collections.Generic.Set`1.op_BitwiseOr(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
  348. <summary>
  349. Performs a "union" of two sets, where all the elements
  350. in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  351. 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
  352. added in. Neither of the input sets is modified by the operation.
  353. </summary>
  354. <param name="a">A set of elements.</param>
  355. <param name="b">A set of elements.</param>
  356. <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  357. </member>
  358. <member name="M:Iesi.Collections.Generic.Set`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
  359. <summary>
  360. Performs an "intersection" of the two sets, where only the elements
  361. that are present in both sets remain. That is, the element is included if it exists in
  362. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  363. a <c>Clone()</c> of this set with the appropriate elements removed.
  364. </summary>
  365. <param name="a">A set of elements.</param>
  366. <returns>The intersection of this set with <c>a</c>.</returns>
  367. </member>
  368. <member name="M:Iesi.Collections.Generic.Set`1.Intersect(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
  369. <summary>
  370. Performs an "intersection" of the two sets, where only the elements
  371. that are present in both sets remain. That is, the element is included only if it exists in
  372. both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
  373. 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
  374. elements from the intersect operation.
  375. </summary>
  376. <param name="a">A set of elements.</param>
  377. <param name="b">A set of elements.</param>
  378. <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  379. </member>
  380. <member name="M:Iesi.Collections.Generic.Set`1.op_BitwiseAnd(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
  381. <summary>
  382. Performs an "intersection" of the two sets, where only the elements
  383. that are present in both sets remain. That is, the element is included only if it exists in
  384. both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
  385. 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
  386. elements from the intersect operation.
  387. </summary>
  388. <param name="a">A set of elements.</param>
  389. <param name="b">A set of elements.</param>
  390. <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  391. </member>
  392. <member name="M:Iesi.Collections.Generic.Set`1.Minus(Iesi.Collections.Generic.ISet{`0})">
  393. <summary>
  394. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  395. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  396. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  397. of this <c>Set</c> containing the elements from the operation.
  398. </summary>
  399. <param name="a">A set of elements.</param>
  400. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  401. </member>
  402. <member name="M:Iesi.Collections.Generic.Set`1.Minus(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
  403. <summary>
  404. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  405. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  406. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  407. of set <c>a</c> containing the elements from the operation.
  408. </summary>
  409. <param name="a">A set of elements.</param>
  410. <param name="b">A set of elements.</param>
  411. <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
  412. </member>
  413. <member name="M:Iesi.Collections.Generic.Set`1.op_Subtraction(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
  414. <summary>
  415. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  416. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  417. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  418. of set <c>a</c> containing the elements from the operation.
  419. </summary>
  420. <param name="a">A set of elements.</param>
  421. <param name="b">A set of elements.</param>
  422. <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
  423. </member>
  424. <member name="M:Iesi.Collections.Generic.Set`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
  425. <summary>
  426. Performs an "exclusive-or" of the two sets, keeping only the elements that
  427. are in one of the sets, but not in both. The original sets are not modified
  428. during this operation. The result set is a <c>Clone()</c> of this set containing
  429. the elements from the exclusive-or operation.
  430. </summary>
  431. <param name="a">A set of elements.</param>
  432. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  433. </member>
  434. <member name="M:Iesi.Collections.Generic.Set`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0},Iesi.Collections.Generic.ISet{`0})">
  435. <summary>
  436. Performs an "exclusive-or" of the two sets, keeping only the elements that
  437. are in one of the sets, but not in both. The original sets are not modified
  438. during this operation. The result set is a <c>Clone()</c> of one of the sets
  439. (<c>a</c> if it is not <see langword="null" />) containing
  440. the elements from the exclusive-or operation.
  441. </summary>
  442. <param name="a">A set of elements.</param>
  443. <param name="b">A set of elements.</param>
  444. <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  445. </member>
  446. <member name="M:Iesi.Collections.Generic.Set`1.op_ExclusiveOr(Iesi.Collections.Generic.Set{`0},Iesi.Collections.Generic.Set{`0})">
  447. <summary>
  448. Performs an "exclusive-or" of the two sets, keeping only the elements that
  449. are in one of the sets, but not in both. The original sets are not modified
  450. during this operation. The result set is a <c>Clone()</c> of one of the sets
  451. (<c>a</c> if it is not <see langword="null" />) containing
  452. the elements from the exclusive-or operation.
  453. </summary>
  454. <param name="a">A set of elements.</param>
  455. <param name="b">A set of elements.</param>
  456. <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  457. </member>
  458. <member name="M:Iesi.Collections.Generic.Set`1.Add(`0)">
  459. <summary>
  460. Adds the specified element to this set if it is not already present.
  461. </summary>
  462. <param name="o">The object to add to the set.</param>
  463. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  464. </member>
  465. <member name="M:Iesi.Collections.Generic.Set`1.AddAll(System.Collections.Generic.ICollection{`0})">
  466. <summary>
  467. Adds all the elements in the specified collection to the set if they are not already present.
  468. </summary>
  469. <param name="c">A collection of objects to add to the set.</param>
  470. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  471. </member>
  472. <member name="M:Iesi.Collections.Generic.Set`1.Clear">
  473. <summary>
  474. Removes all objects from the set.
  475. </summary>
  476. </member>
  477. <member name="M:Iesi.Collections.Generic.Set`1.Contains(`0)">
  478. <summary>
  479. Returns <see langword="true" /> if this set contains the specified element.
  480. </summary>
  481. <param name="o">The element to look for.</param>
  482. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  483. </member>
  484. <member name="M:Iesi.Collections.Generic.Set`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
  485. <summary>
  486. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  487. </summary>
  488. <param name="c">A collection of objects.</param>
  489. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  490. </member>
  491. <member name="M:Iesi.Collections.Generic.Set`1.Remove(`0)">
  492. <summary>
  493. Removes the specified element from the set.
  494. </summary>
  495. <param name="o">The element to be removed.</param>
  496. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  497. </member>
  498. <member name="M:Iesi.Collections.Generic.Set`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
  499. <summary>
  500. Remove all the specified elements from this set, if they exist in this set.
  501. </summary>
  502. <param name="c">A collection of elements to remove.</param>
  503. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  504. </member>
  505. <member name="M:Iesi.Collections.Generic.Set`1.RetainAll(System.Collections.Generic.ICollection{`0})">
  506. <summary>
  507. Retains only the elements in this set that are contained in the specified collection.
  508. </summary>
  509. <param name="c">Collection that defines the set of elements to be retained.</param>
  510. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  511. </member>
  512. <member name="M:Iesi.Collections.Generic.Set`1.Clone">
  513. <summary>
  514. Returns a clone of the <c>Set</c> instance. This will work for derived <c>Set</c>
  515. classes if the derived class implements a constructor that takes no arguments.
  516. </summary>
  517. <returns>A clone of this object.</returns>
  518. </member>
  519. <member name="M:Iesi.Collections.Generic.Set`1.CopyTo(`0[],System.Int32)">
  520. <summary>
  521. Copies the elements in the <c>Set</c> to an array. The type of array needs
  522. to be compatible with the objects in the <c>Set</c>, obviously.
  523. </summary>
  524. <param name="array">An array that will be the target of the copy operation.</param>
  525. <param name="index">The zero-based index where copying will start.</param>
  526. </member>
  527. <member name="M:Iesi.Collections.Generic.Set`1.GetEnumerator">
  528. <summary>
  529. Gets an enumerator for the elements in the <c>Set</c>.
  530. </summary>
  531. <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
  532. </member>
  533. <member name="M:Iesi.Collections.Generic.Set`1.NonGenericCopyTo(System.Array,System.Int32)">
  534. <summary>
  535. Performs CopyTo when called trhough non-generic ISet (ICollection) interface
  536. </summary>
  537. <param name="array"></param>
  538. <param name="index"></param>
  539. </member>
  540. <member name="M:Iesi.Collections.Generic.Set`1.NonGenericUnion(Iesi.Collections.ISet)">
  541. <summary>
  542. Performs Union when called trhough non-generic ISet interface
  543. </summary>
  544. <param name="a"></param>
  545. <returns></returns>
  546. </member>
  547. <member name="M:Iesi.Collections.Generic.Set`1.NonGenericMinus(Iesi.Collections.ISet)">
  548. <summary>
  549. Performs Minus when called trhough non-generic ISet interface
  550. </summary>
  551. <param name="a"></param>
  552. <returns></returns>
  553. </member>
  554. <member name="M:Iesi.Collections.Generic.Set`1.NonGenericIntersect(Iesi.Collections.ISet)">
  555. <summary>
  556. Performs Intersect when called trhough non-generic ISet interface
  557. </summary>
  558. <param name="a"></param>
  559. <returns></returns>
  560. </member>
  561. <member name="M:Iesi.Collections.Generic.Set`1.NonGenericExclusiveOr(Iesi.Collections.ISet)">
  562. <summary>
  563. Performs ExclusiveOr when called trhough non-generic ISet interface
  564. </summary>
  565. <param name="a"></param>
  566. <returns></returns>
  567. </member>
  568. <member name="P:Iesi.Collections.Generic.Set`1.IsEmpty">
  569. <summary>
  570. Returns <see langword="true" /> if this set contains no elements.
  571. </summary>
  572. </member>
  573. <member name="P:Iesi.Collections.Generic.Set`1.Count">
  574. <summary>
  575. The number of elements currently contained in this collection.
  576. </summary>
  577. </member>
  578. <member name="P:Iesi.Collections.Generic.Set`1.IsSynchronized">
  579. <summary>
  580. Returns <see langword="true" /> if the <c>Set</c> is synchronized across threads. Note that
  581. enumeration is inherently not thread-safe. Use the <c>SyncRoot</c> to lock the
  582. object during enumeration.
  583. </summary>
  584. </member>
  585. <member name="P:Iesi.Collections.Generic.Set`1.SyncRoot">
  586. <summary>
  587. An object that can be used to synchronize this collection to make it thread-safe.
  588. When implementing this, if your object uses a base object, like an <c>IDictionary</c>,
  589. or anything that has a <c>SyncRoot</c>, return that object instead of "<c>this</c>".
  590. </summary>
  591. </member>
  592. <member name="P:Iesi.Collections.Generic.Set`1.IsReadOnly">
  593. <summary>
  594. Indicates whether the given instance is read-only or not
  595. </summary>
  596. <value>
  597. <see langword="true" /> if the ISet is read-only; otherwise, <see langword="false" />.
  598. In the default implementation of Set, this property always returns false.
  599. </value>
  600. </member>
  601. <member name="F:Iesi.Collections.Generic.DictionarySet`1.InternalDictionary">
  602. <summary>
  603. Provides the storage for elements in the <c>Set</c>, stored as the key-set
  604. of the <c>IDictionary</c> object. Set this object in the constructor
  605. if you create your own <c>Set</c> class.
  606. </summary>
  607. </member>
  608. <member name="M:Iesi.Collections.Generic.DictionarySet`1.Add(`0)">
  609. <summary>
  610. Adds the specified element to this set if it is not already present.
  611. </summary>
  612. <param name="o">The <typeparamref name="T"/> to add to the set.</param>
  613. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  614. </member>
  615. <member name="M:Iesi.Collections.Generic.DictionarySet`1.AddAll(System.Collections.Generic.ICollection{`0})">
  616. <summary>
  617. Adds all the elements in the specified collection to the set if they are not already present.
  618. </summary>
  619. <param name="c">A collection of objects to add to the set.</param>
  620. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  621. </member>
  622. <member name="M:Iesi.Collections.Generic.DictionarySet`1.Clear">
  623. <summary>
  624. Removes all objects from the set.
  625. </summary>
  626. </member>
  627. <member name="M:Iesi.Collections.Generic.DictionarySet`1.Contains(`0)">
  628. <summary>
  629. Returns <see langword="true" /> if this set contains the specified element.
  630. </summary>
  631. <param name="o">The element to look for.</param>
  632. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  633. </member>
  634. <member name="M:Iesi.Collections.Generic.DictionarySet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
  635. <summary>
  636. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  637. </summary>
  638. <param name="c">A collection of objects.</param>
  639. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  640. </member>
  641. <member name="M:Iesi.Collections.Generic.DictionarySet`1.Remove(`0)">
  642. <summary>
  643. Removes the specified element from the set.
  644. </summary>
  645. <param name="o">The element to be removed.</param>
  646. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  647. </member>
  648. <member name="M:Iesi.Collections.Generic.DictionarySet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
  649. <summary>
  650. Remove all the specified elements from this set, if they exist in this set.
  651. </summary>
  652. <param name="c">A collection of elements to remove.</param>
  653. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  654. </member>
  655. <member name="M:Iesi.Collections.Generic.DictionarySet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
  656. <summary>
  657. Retains only the elements in this set that are contained in the specified collection.
  658. </summary>
  659. <param name="c">Collection that defines the set of elements to be retained.</param>
  660. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  661. </member>
  662. <member name="M:Iesi.Collections.Generic.DictionarySet`1.CopyTo(`0[],System.Int32)">
  663. <summary>
  664. Copies the elements in the <c>Set</c> to an array of T. The type of array needs
  665. to be compatible with the objects in the <c>Set</c>, obviously.
  666. </summary>
  667. <param name="array">An array that will be the target of the copy operation.</param>
  668. <param name="index">The zero-based index where copying will start.</param>
  669. </member>
  670. <member name="M:Iesi.Collections.Generic.DictionarySet`1.GetEnumerator">
  671. <summary>
  672. Gets an enumerator for the elements in the <c>Set</c>.
  673. </summary>
  674. <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
  675. </member>
  676. <member name="M:Iesi.Collections.Generic.DictionarySet`1.NonGenericCopyTo(System.Array,System.Int32)">
  677. <summary>
  678. Copies the elements in the <c>Set</c> to an array. The type of array needs
  679. to be compatible with the objects in the <c>Set</c>, obviously. Needed for
  680. non-generic ISet methods implementation
  681. </summary>
  682. <param name="array">An array that will be the target of the copy operation.</param>
  683. <param name="index">The zero-based index where copying will start.</param>
  684. </member>
  685. <member name="P:Iesi.Collections.Generic.DictionarySet`1.Placeholder">
  686. <summary>
  687. The placeholder object used as the value for the <c>IDictionary</c> instance.
  688. </summary>
  689. <remarks>
  690. There is a single instance of this object globally, used for all <c>Sets</c>.
  691. </remarks>
  692. </member>
  693. <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsEmpty">
  694. <summary>
  695. Returns <see langword="true" /> if this set contains no elements.
  696. </summary>
  697. </member>
  698. <member name="P:Iesi.Collections.Generic.DictionarySet`1.Count">
  699. <summary>
  700. The number of elements contained in this collection.
  701. </summary>
  702. </member>
  703. <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsSynchronized">
  704. <summary>
  705. None of the objects based on <c>DictionarySet</c> are synchronized. Use the
  706. <c>SyncRoot</c> property instead.
  707. </summary>
  708. </member>
  709. <member name="P:Iesi.Collections.Generic.DictionarySet`1.SyncRoot">
  710. <summary>
  711. Returns an object that can be used to synchronize the <c>Set</c> between threads.
  712. </summary>
  713. </member>
  714. <member name="P:Iesi.Collections.Generic.DictionarySet`1.IsReadOnly">
  715. <summary>
  716. Indicates wether the <c>Set</c> is read-only or not
  717. </summary>
  718. </member>
  719. <member name="T:Iesi.Collections.Generic.HashedSet`1">
  720. <summary>
  721. Implements a <c>Set</c> based on a Dictionary (which is equivalent of
  722. non-genric <c>HashTable</c>) This will give the best lookup, add, and remove
  723. performance for very large data-sets, but iteration will occur in no particular order.
  724. </summary>
  725. </member>
  726. <member name="M:Iesi.Collections.Generic.HashedSet`1.#ctor">
  727. <summary>
  728. Creates a new set instance based on a Dictinary.
  729. </summary>
  730. </member>
  731. <member name="M:Iesi.Collections.Generic.HashedSet`1.#ctor(System.Collections.Generic.ICollection{`0})">
  732. <summary>
  733. Creates a new set instance based on a Dictinary and
  734. initializes it based on a collection of elements.
  735. </summary>
  736. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  737. </member>
  738. <member name="T:Iesi.Collections.Generic.ImmutableSet`1">
  739. <summary>
  740. <p>Implements an immutable (read-only) <c>Set</c> wrapper.</p>
  741. <p>Although this is advertised as immutable, it really isn't. Anyone with access to the
  742. <c>basisSet</c> can still change the data-set. So <c>GetHashCode()</c> is not implemented
  743. for this <c>Set</c>, as is the case for all <c>Set</c> implementations in this library.
  744. This design decision was based on the efficiency of not having to <c>Clone()</c> the
  745. <c>basisSet</c> every time you wrap a mutable <c>Set</c>.</p>
  746. </summary>
  747. </member>
  748. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.#ctor(Iesi.Collections.Generic.ISet{`0})">
  749. <summary>
  750. Constructs an immutable (read-only) <c>Set</c> wrapper.
  751. </summary>
  752. <param name="basisSet">The <c>Set</c> that is wrapped.</param>
  753. </member>
  754. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Add(`0)">
  755. <summary>
  756. Adds the specified element to this set if it is not already present.
  757. </summary>
  758. <param name="o">The object to add to the set.</param>
  759. <returns>nothing</returns>
  760. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  761. </member>
  762. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.AddAll(System.Collections.Generic.ICollection{`0})">
  763. <summary>
  764. Adds all the elements in the specified collection to the set if they are not already present.
  765. </summary>
  766. <param name="c">A collection of objects to add to the set.</param>
  767. <returns>nothing</returns>
  768. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  769. </member>
  770. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Clear">
  771. <summary>
  772. Removes all objects from the set.
  773. </summary>
  774. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  775. </member>
  776. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Contains(`0)">
  777. <summary>
  778. Returns <see langword="true" /> if this set contains the specified element.
  779. </summary>
  780. <param name="o">The element to look for.</param>
  781. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  782. </member>
  783. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
  784. <summary>
  785. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  786. </summary>
  787. <param name="c">A collection of objects.</param>
  788. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  789. </member>
  790. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Remove(`0)">
  791. <summary>
  792. Removes the specified element from the set.
  793. </summary>
  794. <param name="o">The element to be removed.</param>
  795. <returns>nothing</returns>
  796. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  797. </member>
  798. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
  799. <summary>
  800. Remove all the specified elements from this set, if they exist in this set.
  801. </summary>
  802. <param name="c">A collection of elements to remove.</param>
  803. <returns>nothing</returns>
  804. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  805. </member>
  806. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
  807. <summary>
  808. Retains only the elements in this set that are contained in the specified collection.
  809. </summary>
  810. <param name="c">Collection that defines the set of elements to be retained.</param>
  811. <returns>nothing</returns>
  812. <exception cref="T:System.NotSupportedException"> is always thrown</exception>
  813. </member>
  814. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.CopyTo(`0[],System.Int32)">
  815. <summary>
  816. Copies the elements in the <c>Set</c> to an array of T. The type of array needs
  817. to be compatible with the objects in the <c>Set</c>, obviously.
  818. </summary>
  819. <param name="array">An array that will be the target of the copy operation.</param>
  820. <param name="index">The zero-based index where copying will start.</param>
  821. </member>
  822. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.GetEnumerator">
  823. <summary>
  824. Gets an enumerator for the elements in the <c>Set</c>.
  825. </summary>
  826. <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
  827. </member>
  828. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Clone">
  829. <summary>
  830. Returns a clone of the <c>Set</c> instance.
  831. </summary>
  832. <returns>A clone of this object.</returns>
  833. </member>
  834. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Union(Iesi.Collections.Generic.ISet{`0})">
  835. <summary>
  836. Performs a "union" of the two sets, where all the elements
  837. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  838. Neither this set nor the input set are modified during the operation. The return value
  839. is a <c>Clone()</c> of this set with the extra elements added in.
  840. </summary>
  841. <param name="a">A collection of elements.</param>
  842. <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
  843. Neither of the input objects is modified by the union.</returns>
  844. </member>
  845. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Intersect(Iesi.Collections.Generic.ISet{`0})">
  846. <summary>
  847. Performs an "intersection" of the two sets, where only the elements
  848. that are present in both sets remain. That is, the element is included if it exists in
  849. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  850. a <c>Clone()</c> of this set with the appropriate elements removed.
  851. </summary>
  852. <param name="a">A set of elements.</param>
  853. <returns>The intersection of this set with <c>a</c>.</returns>
  854. </member>
  855. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.Minus(Iesi.Collections.Generic.ISet{`0})">
  856. <summary>
  857. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  858. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  859. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  860. of this <c>Set</c> containing the elements from the operation.
  861. </summary>
  862. <param name="a">A set of elements.</param>
  863. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  864. </member>
  865. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.ExclusiveOr(Iesi.Collections.Generic.ISet{`0})">
  866. <summary>
  867. Performs an "exclusive-or" of the two sets, keeping only the elements that
  868. are in one of the sets, but not in both. The original sets are not modified
  869. during this operation. The result set is a <c>Clone()</c> of this set containing
  870. the elements from the exclusive-or operation.
  871. </summary>
  872. <param name="a">A set of elements.</param>
  873. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  874. </member>
  875. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericCopyTo(System.Array,System.Int32)">
  876. <summary>
  877. Performs CopyTo when called trhough non-generic ISet (ICollection) interface
  878. </summary>
  879. <param name="array"></param>
  880. <param name="index"></param>
  881. </member>
  882. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericUnion(Iesi.Collections.ISet)">
  883. <summary>
  884. Performs Union when called trhough non-generic ISet interface
  885. </summary>
  886. <param name="a"></param>
  887. <returns></returns>
  888. </member>
  889. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericMinus(Iesi.Collections.ISet)">
  890. <summary>
  891. Performs Minus when called trhough non-generic ISet interface
  892. </summary>
  893. <param name="a"></param>
  894. <returns></returns>
  895. </member>
  896. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericIntersect(Iesi.Collections.ISet)">
  897. <summary>
  898. Performs Intersect when called trhough non-generic ISet interface
  899. </summary>
  900. <param name="a"></param>
  901. <returns></returns>
  902. </member>
  903. <member name="M:Iesi.Collections.Generic.ImmutableSet`1.NonGenericExclusiveOr(Iesi.Collections.ISet)">
  904. <summary>
  905. Performs ExclusiveOr when called trhough non-generic ISet interface
  906. </summary>
  907. <param name="a"></param>
  908. <returns></returns>
  909. </member>
  910. <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsEmpty">
  911. <summary>
  912. Returns <see langword="true" /> if this set contains no elements.
  913. </summary>
  914. </member>
  915. <member name="P:Iesi.Collections.Generic.ImmutableSet`1.Count">
  916. <summary>
  917. The number of elements contained in this collection.
  918. </summary>
  919. </member>
  920. <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsSynchronized">
  921. <summary>
  922. Returns an object that can be used to synchronize use of the <c>Set</c> across threads.
  923. </summary>
  924. </member>
  925. <member name="P:Iesi.Collections.Generic.ImmutableSet`1.SyncRoot">
  926. <summary>
  927. Returns an object that can be used to synchronize the <c>Set</c> between threads.
  928. </summary>
  929. </member>
  930. <member name="P:Iesi.Collections.Generic.ImmutableSet`1.IsReadOnly">
  931. <summary>
  932. Indicates that the given instance is read-only
  933. </summary>
  934. </member>
  935. <member name="T:Iesi.Collections.Generic.OrderedSet`1">
  936. <summary>
  937. Implements an ordered <c>Set</c> based on a dictionary.
  938. </summary>
  939. </member>
  940. <member name="M:Iesi.Collections.Generic.OrderedSet`1.#ctor">
  941. <summary>
  942. Initializes a new instance of the <see cref="T:Iesi.Collections.Generic.OrderedSet`1"/> class.
  943. </summary>
  944. </member>
  945. <member name="M:Iesi.Collections.Generic.OrderedSet`1.#ctor(System.Collections.Generic.ICollection{`0})">
  946. <summary>
  947. Initializes a new instance of the <see cref="T:Iesi.Collections.Generic.OrderedSet`1"/> class.
  948. </summary>
  949. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  950. </member>
  951. <member name="T:Iesi.Collections.Generic.SortedSet`1">
  952. <summary>
  953. Implements a <c>Set</c> based on a sorted tree. This gives good performance for operations on very
  954. large data-sets, though not as good - asymptotically - as a <c>HashedSet</c>. However, iteration
  955. occurs in order. Elements that you put into this type of collection must implement <c>IComparable</c>,
  956. and they must actually be comparable. You can't mix <c>string</c> and <c>int</c> values, for example.
  957. </summary>
  958. </member>
  959. <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor">
  960. <summary>
  961. Creates a new set instance based on a sorted tree.
  962. </summary>
  963. </member>
  964. <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.IComparer{`0})">
  965. <summary>
  966. Creates a new set instance based on a sorted tree.
  967. </summary>
  968. <param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1"/> to use for sorting.</param>
  969. </member>
  970. <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.ICollection{`0})">
  971. <summary>
  972. Creates a new set instance based on a sorted tree and
  973. initializes it based on a collection of elements.
  974. </summary>
  975. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  976. </member>
  977. <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.ICollection)">
  978. <summary>
  979. Creates a new set instance based on a sorted tree and
  980. initializes it based on a collection of elements.
  981. </summary>
  982. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  983. </member>
  984. <member name="M:Iesi.Collections.Generic.SortedSet`1.#ctor(System.Collections.Generic.ICollection{`0},System.Collections.Generic.IComparer{`0})">
  985. <summary>
  986. Creates a new set instance based on a sorted tree and
  987. initializes it based on a collection of elements.
  988. </summary>
  989. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  990. <param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1"/> to use for sorting.</param>
  991. </member>
  992. <member name="T:Iesi.Collections.Generic.SynchronizedSet`1">
  993. <summary>
  994. <p>Implements a thread-safe <c>Set</c> wrapper. The implementation is extremely conservative,
  995. serializing critical sections to prevent possible deadlocks, and locking on everything.
  996. The one exception is for enumeration, which is inherently not thread-safe. For this, you
  997. have to <c>lock</c> the <c>SyncRoot</c> object for the duration of the enumeration.</p>
  998. </summary>
  999. </member>
  1000. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.#ctor(Iesi.Collections.Generic.ISet{`0})">
  1001. <summary>
  1002. Constructs a thread-safe <c>Set</c> wrapper.
  1003. </summary>
  1004. <param name="basisSet">The <c>Set</c> object that this object will wrap.</param>
  1005. </member>
  1006. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Add(`0)">
  1007. <summary>
  1008. Adds the specified element to this set if it is not already present.
  1009. </summary>
  1010. <param name="o">The object to add to the set.</param>
  1011. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  1012. </member>
  1013. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.AddAll(System.Collections.Generic.ICollection{`0})">
  1014. <summary>
  1015. Adds all the elements in the specified collection to the set if they are not already present.
  1016. </summary>
  1017. <param name="c">A collection of objects to add to the set.</param>
  1018. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  1019. </member>
  1020. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Clear">
  1021. <summary>
  1022. Removes all objects from the set.
  1023. </summary>
  1024. </member>
  1025. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Contains(`0)">
  1026. <summary>
  1027. Returns <see langword="true" /> if this set contains the specified element.
  1028. </summary>
  1029. <param name="o">The element to look for.</param>
  1030. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  1031. </member>
  1032. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.ContainsAll(System.Collections.Generic.ICollection{`0})">
  1033. <summary>
  1034. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  1035. </summary>
  1036. <param name="c">A collection of objects.</param>
  1037. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  1038. </member>
  1039. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Remove(`0)">
  1040. <summary>
  1041. Removes the specified element from the set.
  1042. </summary>
  1043. <param name="o">The element to be removed.</param>
  1044. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  1045. </member>
  1046. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.RemoveAll(System.Collections.Generic.ICollection{`0})">
  1047. <summary>
  1048. Remove all the specified elements from this set, if they exist in this set.
  1049. </summary>
  1050. <param name="c">A collection of elements to remove.</param>
  1051. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  1052. </member>
  1053. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.RetainAll(System.Collections.Generic.ICollection{`0})">
  1054. <summary>
  1055. Retains only the elements in this set that are contained in the specified collection.
  1056. </summary>
  1057. <param name="c">Collection that defines the set of elements to be retained.</param>
  1058. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  1059. </member>
  1060. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.CopyTo(`0[],System.Int32)">
  1061. <summary>
  1062. Copies the elements in the <c>Set</c> to an array. The type of array needs
  1063. to be compatible with the objects in the <c>Set</c>, obviously.
  1064. </summary>
  1065. <param name="array">An array that will be the target of the copy operation.</param>
  1066. <param name="index">The zero-based index where copying will start.</param>
  1067. </member>
  1068. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.GetEnumerator">
  1069. <summary>
  1070. Enumeration is, by definition, not thread-safe. Use a <c>lock</c> on the <c>SyncRoot</c>
  1071. to synchronize the entire enumeration process.
  1072. </summary>
  1073. <returns></returns>
  1074. </member>
  1075. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.Clone">
  1076. <summary>
  1077. Returns a clone of the <c>Set</c> instance.
  1078. </summary>
  1079. <returns>A clone of this object.</returns>
  1080. </member>
  1081. <member name="M:Iesi.Collections.Generic.SynchronizedSet`1.NonGenericCopyTo(System.Array,System.Int32)">
  1082. <summary>
  1083. Performs CopyTo when called trhough non-generic ISet (ICollection) interface
  1084. </summary>
  1085. <param name="array"></param>
  1086. <param name="index"></param>
  1087. </member>
  1088. <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsEmpty">
  1089. <summary>
  1090. Returns <see langword="true" /> if this set contains no elements.
  1091. </summary>
  1092. </member>
  1093. <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.Count">
  1094. <summary>
  1095. The number of elements contained in this collection.
  1096. </summary>
  1097. </member>
  1098. <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsSynchronized">
  1099. <summary>
  1100. Returns <see langword="true" />, indicating that this object is thread-safe. The exception to this
  1101. is enumeration, which is inherently not thread-safe. Use the <c>SyncRoot</c> object to
  1102. lock this object for the entire duration of the enumeration.
  1103. </summary>
  1104. </member>
  1105. <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.SyncRoot">
  1106. <summary>
  1107. Returns an object that can be used to synchronize the <c>Set</c> between threads.
  1108. </summary>
  1109. </member>
  1110. <member name="P:Iesi.Collections.Generic.SynchronizedSet`1.IsReadOnly">
  1111. <summary>
  1112. Indicates whether given instace is read-only or not
  1113. </summary>
  1114. </member>
  1115. <member name="T:Iesi.Collections.DictionarySet">
  1116. <summary>
  1117. <p><c>DictionarySet</c> is an abstract class that supports the creation of new <c>Set</c>
  1118. types where the underlying data store is an <c>IDictionary</c> instance.</p>
  1119. <p>You can use any object that implements the <c>IDictionary</c> interface to hold set data.
  1120. You can define your own, or you can use one of the objects provided in the Framework.
  1121. The type of <c>IDictionary</c> you choose will affect both the performance and the behavior
  1122. of the <c>Set</c> using it. </p>
  1123. <p>To make a <c>Set</c> typed based on your own <c>IDictionary</c>, simply derive a
  1124. new class with a constructor that takes no parameters. Some <c>Set</c> implmentations
  1125. cannot be defined with a default constructor. If this is the case for your class,
  1126. you will need to override <c>Clone()</c> as well.</p>
  1127. <p>It is also standard practice that at least one of your constructors takes an <c>ICollection</c> or
  1128. an <c>ISet</c> as an argument.</p>
  1129. </summary>
  1130. </member>
  1131. <member name="T:Iesi.Collections.Set">
  1132. <summary>A collection that contains no duplicate elements.</summary>
  1133. <remarks>
  1134. <para>
  1135. This class models the mathematical set abstraction, and is the base class for all
  1136. other set implementations. The order of elements in a set is dependant on
  1137. (a) the data-structure implementation, and (b) the implementation of the various
  1138. methods, and thus is not guaranteed.
  1139. </para>
  1140. <para>
  1141. None of the <see cref="T:Iesi.Collections.ISet"/> implementations in this library are guranteed to be thread-safe
  1142. in any way unless wrapped in a <see cref="T:Iesi.Collections.SynchronizedSet"/>.
  1143. </para>
  1144. <para>
  1145. The following table summarizes the binary operators that are supported by the <see cref="T:Iesi.Collections.ISet"/>
  1146. type.
  1147. </para>
  1148. <list type="table">
  1149. <listheader>
  1150. <term>Operation</term>
  1151. <term>Description</term>
  1152. <term>Method</term>
  1153. <term>Operator</term>
  1154. </listheader>
  1155. <item>
  1156. <term>Union (OR)</term>
  1157. <term>Element included in result if it exists in either <c>A</c> OR <c>B</c>.</term>
  1158. <term><c>Union()</c></term>
  1159. <term><c>|</c></term>
  1160. </item>
  1161. <item>
  1162. <term>Intersection (AND)</term>
  1163. <term>Element included in result if it exists in both <c>A</c> AND <c>B</c>.</term>
  1164. <term><c>InterSect()</c></term>
  1165. <term><c>&amp;</c></term>
  1166. </item>
  1167. <item>
  1168. <term>Exclusive Or (XOR)</term>
  1169. <term>Element included in result if it exists in one, but not both, of <c>A</c> and <c>B</c>.</term>
  1170. <term><c>ExclusiveOr()</c></term>
  1171. <term><c>^</c></term>
  1172. </item>
  1173. <item>
  1174. <term>Minus (n/a)</term>
  1175. <term>Take all the elements in <c>A</c>. Now, if any of them exist in <c>B</c>, remove
  1176. them. Note that unlike the other operators, <c>A - B</c> is not the same as <c>B - A</c>.</term>
  1177. <term><c>Minus()</c></term>
  1178. <term><c>-</c></term>
  1179. </item>
  1180. </list>
  1181. </remarks>
  1182. </member>
  1183. <member name="M:Iesi.Collections.Set.Union(Iesi.Collections.ISet)">
  1184. <summary>
  1185. Performs a "union" of the two sets, where all the elements
  1186. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  1187. Neither this set nor the input set are modified during the operation. The return value
  1188. is a clone of this set with the extra elements added in.
  1189. </summary>
  1190. <param name="a">A collection of elements.</param>
  1191. <returns>A new <see cref="T:Iesi.Collections.ISet"/> instance containing the union of this instance with the specified collection.
  1192. Neither of the input objects is modified by the union.</returns>
  1193. </member>
  1194. <member name="M:Iesi.Collections.Set.Union(Iesi.Collections.ISet,Iesi.Collections.ISet)">
  1195. <summary>
  1196. Performs a "union" of two sets, where all the elements
  1197. in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  1198. 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
  1199. added in. Neither of the input sets is modified by the operation.
  1200. </summary>
  1201. <param name="a">A set of elements.</param>
  1202. <param name="b">A set of elements.</param>
  1203. <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1204. </member>
  1205. <member name="M:Iesi.Collections.Set.op_BitwiseOr(Iesi.Collections.Set,Iesi.Collections.Set)">
  1206. <summary>
  1207. Performs a "union" of two sets, where all the elements
  1208. in both are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  1209. 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
  1210. added in. Neither of the input sets is modified by the operation.
  1211. </summary>
  1212. <param name="a">A set of elements.</param>
  1213. <param name="b">A set of elements.</param>
  1214. <returns>A set containing the union of the input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1215. </member>
  1216. <member name="M:Iesi.Collections.Set.Intersect(Iesi.Collections.ISet)">
  1217. <summary>
  1218. Performs an "intersection" of the two sets, where only the elements
  1219. that are present in both sets remain. That is, the element is included if it exists in
  1220. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  1221. a <c>Clone()</c> of this set with the appropriate elements removed.
  1222. </summary>
  1223. <param name="a">A set of elements.</param>
  1224. <returns>The intersection of this set with <c>a</c>.</returns>
  1225. </member>
  1226. <member name="M:Iesi.Collections.Set.Intersect(Iesi.Collections.ISet,Iesi.Collections.ISet)">
  1227. <summary>
  1228. Performs an "intersection" of the two sets, where only the elements
  1229. that are present in both sets remain. That is, the element is included only if it exists in
  1230. both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
  1231. 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
  1232. elements from the intersect operation.
  1233. </summary>
  1234. <param name="a">A set of elements.</param>
  1235. <param name="b">A set of elements.</param>
  1236. <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1237. </member>
  1238. <member name="M:Iesi.Collections.Set.op_BitwiseAnd(Iesi.Collections.Set,Iesi.Collections.Set)">
  1239. <summary>
  1240. Performs an "intersection" of the two sets, where only the elements
  1241. that are present in both sets remain. That is, the element is included only if it exists in
  1242. both <c>a</c> and <c>b</c>. Neither input object is modified by the operation.
  1243. 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
  1244. elements from the intersect operation.
  1245. </summary>
  1246. <param name="a">A set of elements.</param>
  1247. <param name="b">A set of elements.</param>
  1248. <returns>The intersection of the two input sets. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1249. </member>
  1250. <member name="M:Iesi.Collections.Set.Minus(Iesi.Collections.ISet)">
  1251. <summary>
  1252. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  1253. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  1254. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  1255. of this <c>Set</c> containing the elements from the operation.
  1256. </summary>
  1257. <param name="a">A set of elements.</param>
  1258. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  1259. </member>
  1260. <member name="M:Iesi.Collections.Set.Minus(Iesi.Collections.ISet,Iesi.Collections.ISet)">
  1261. <summary>
  1262. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  1263. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  1264. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  1265. of set <c>a</c> containing the elements from the operation.
  1266. </summary>
  1267. <param name="a">A set of elements.</param>
  1268. <param name="b">A set of elements.</param>
  1269. <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
  1270. </member>
  1271. <member name="M:Iesi.Collections.Set.op_Subtraction(Iesi.Collections.Set,Iesi.Collections.Set)">
  1272. <summary>
  1273. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  1274. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  1275. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  1276. of set <c>a</c> containing the elements from the operation.
  1277. </summary>
  1278. <param name="a">A set of elements.</param>
  1279. <param name="b">A set of elements.</param>
  1280. <returns>A set containing <c>A - B</c> elements. <see langword="null" /> if <c>a</c> is <see langword="null" />.</returns>
  1281. </member>
  1282. <member name="M:Iesi.Collections.Set.ExclusiveOr(Iesi.Collections.ISet)">
  1283. <summary>
  1284. Performs an "exclusive-or" of the two sets, keeping only the elements that
  1285. are in one of the sets, but not in both. The original sets are not modified
  1286. during this operation. The result set is a clone of this set containing
  1287. the elements from the exclusive-or operation.
  1288. </summary>
  1289. <param name="a">A set of elements.</param>
  1290. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  1291. </member>
  1292. <member name="M:Iesi.Collections.Set.ExclusiveOr(Iesi.Collections.ISet,Iesi.Collections.ISet)">
  1293. <summary>
  1294. Performs an "exclusive-or" of the two sets, keeping only the elements that
  1295. are in one of the sets, but not in both. The original sets are not modified
  1296. during this operation. The result set is a clone of one of the sets
  1297. (<c>a</c> if it is not <see langword="null" />) containing
  1298. the elements from the exclusive-or operation.
  1299. </summary>
  1300. <param name="a">A set of elements.</param>
  1301. <param name="b">A set of elements.</param>
  1302. <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1303. </member>
  1304. <member name="M:Iesi.Collections.Set.op_ExclusiveOr(Iesi.Collections.Set,Iesi.Collections.Set)">
  1305. <summary>
  1306. Performs an "exclusive-or" of the two sets, keeping only the elements that
  1307. are in one of the sets, but not in both. The original sets are not modified
  1308. during this operation. The result set is a clone of one of the sets
  1309. (<c>a</c> if it is not <see langword="null" />) containing
  1310. the elements from the exclusive-or operation.
  1311. </summary>
  1312. <param name="a">A set of elements.</param>
  1313. <param name="b">A set of elements.</param>
  1314. <returns>A set containing the result of <c>a ^ b</c>. <see langword="null" /> if both sets are <see langword="null" />.</returns>
  1315. </member>
  1316. <member name="M:Iesi.Collections.Set.Add(System.Object)">
  1317. <summary>
  1318. Adds the specified element to this set if it is not already present.
  1319. </summary>
  1320. <param name="o">The object to add to the set.</param>
  1321. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  1322. </member>
  1323. <member name="M:Iesi.Collections.Set.AddAll(System.Collections.ICollection)">
  1324. <summary>
  1325. Adds all the elements in the specified collection to the set if they are not already present.
  1326. </summary>
  1327. <param name="c">A collection of objects to add to the set.</param>
  1328. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  1329. </member>
  1330. <member name="M:Iesi.Collections.Set.Clear">
  1331. <summary>
  1332. Removes all objects from the set.
  1333. </summary>
  1334. </member>
  1335. <member name="M:Iesi.Collections.Set.Contains(System.Object)">
  1336. <summary>
  1337. Returns <see langword="true" /> if this set contains the specified element.
  1338. </summary>
  1339. <param name="o">The element to look for.</param>
  1340. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  1341. </member>
  1342. <member name="M:Iesi.Collections.Set.ContainsAll(System.Collections.ICollection)">
  1343. <summary>
  1344. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  1345. </summary>
  1346. <param name="c">A collection of objects.</param>
  1347. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  1348. </member>
  1349. <member name="M:Iesi.Collections.Set.Remove(System.Object)">
  1350. <summary>
  1351. Removes the specified element from the set.
  1352. </summary>
  1353. <param name="o">The element to be removed.</param>
  1354. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  1355. </member>
  1356. <member name="M:Iesi.Collections.Set.RemoveAll(System.Collections.ICollection)">
  1357. <summary>
  1358. Remove all the specified elements from this set, if they exist in this set.
  1359. </summary>
  1360. <param name="c">A collection of elements to remove.</param>
  1361. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  1362. </member>
  1363. <member name="M:Iesi.Collections.Set.RetainAll(System.Collections.ICollection)">
  1364. <summary>
  1365. Retains only the elements in this set that are contained in the specified collection.
  1366. </summary>
  1367. <param name="c">Collection that defines the set of elements to be retained.</param>
  1368. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  1369. </member>
  1370. <member name="M:Iesi.Collections.Set.Clone">
  1371. <summary>
  1372. Returns a clone of the set instance. This will work for derived set
  1373. classes if the derived class implements a constructor that takes no arguments.
  1374. </summary>
  1375. <returns>A clone of this object.</returns>
  1376. </member>
  1377. <member name="M:Iesi.Collections.Set.CopyTo(System.Array,System.Int32)">
  1378. <summary>
  1379. Copies the elements in the set to an array. The type of array needs
  1380. to be compatible with the objects in the set, obviously.
  1381. </summary>
  1382. <param name="array">An array that will be the target of the copy operation.</param>
  1383. <param name="index">The zero-based index where copying will start.</param>
  1384. </member>
  1385. <member name="M:Iesi.Collections.Set.GetEnumerator">
  1386. <summary>
  1387. Returns an enumerator that iterates through the set.
  1388. </summary>
  1389. <returns>
  1390. An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the set.
  1391. </returns>
  1392. </member>
  1393. <member name="P:Iesi.Collections.Set.IsEmpty">
  1394. <summary>
  1395. Returns <see langword="true" /> if this set contains no elements.
  1396. </summary>
  1397. </member>
  1398. <member name="P:Iesi.Collections.Set.Count">
  1399. <summary>
  1400. The number of elements currently contained in this collection.
  1401. </summary>
  1402. </member>
  1403. <member name="P:Iesi.Collections.Set.IsSynchronized">
  1404. <summary>
  1405. Returns <see langword="true"/> if the set is synchronized across threads. Note that
  1406. enumeration is inherently not thread-safe. Use the <see cref="P:Iesi.Collections.Set.SyncRoot"/> to lock the
  1407. object during enumeration.
  1408. </summary>
  1409. </member>
  1410. <member name="P:Iesi.Collections.Set.SyncRoot">
  1411. <summary>
  1412. An object that can be used to synchronize this collection to make it thread-safe.
  1413. When implementing this, if your object uses a base object, like an <see cref="T:System.Collections.IDictionary"/>,
  1414. or anything that has a <see cref="P:Iesi.Collections.Set.SyncRoot"/>, return that object instead
  1415. of <see langword="this"/>.
  1416. </summary>
  1417. </member>
  1418. <member name="F:Iesi.Collections.DictionarySet.InternalDictionary">
  1419. <summary>
  1420. Provides the storage for elements in the <c>Set</c>, stored as the key-set
  1421. of the <c>IDictionary</c> object. Set this object in the constructor
  1422. if you create your own <c>Set</c> class.
  1423. </summary>
  1424. </member>
  1425. <member name="M:Iesi.Collections.DictionarySet.Add(System.Object)">
  1426. <summary>
  1427. Adds the specified element to this set if it is not already present.
  1428. </summary>
  1429. <param name="o">The object to add to the set.</param>
  1430. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  1431. </member>
  1432. <member name="M:Iesi.Collections.DictionarySet.AddAll(System.Collections.ICollection)">
  1433. <summary>
  1434. Adds all the elements in the specified collection to the set if they are not already present.
  1435. </summary>
  1436. <param name="c">A collection of objects to add to the set.</param>
  1437. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  1438. </member>
  1439. <member name="M:Iesi.Collections.DictionarySet.Clear">
  1440. <summary>
  1441. Removes all objects from the set.
  1442. </summary>
  1443. </member>
  1444. <member name="M:Iesi.Collections.DictionarySet.Contains(System.Object)">
  1445. <summary>
  1446. Returns <see langword="true" /> if this set contains the specified element.
  1447. </summary>
  1448. <param name="o">The element to look for.</param>
  1449. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  1450. </member>
  1451. <member name="M:Iesi.Collections.DictionarySet.ContainsAll(System.Collections.ICollection)">
  1452. <summary>
  1453. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  1454. </summary>
  1455. <param name="c">A collection of objects.</param>
  1456. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  1457. </member>
  1458. <member name="M:Iesi.Collections.DictionarySet.Remove(System.Object)">
  1459. <summary>
  1460. Removes the specified element from the set.
  1461. </summary>
  1462. <param name="o">The element to be removed.</param>
  1463. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  1464. </member>
  1465. <member name="M:Iesi.Collections.DictionarySet.RemoveAll(System.Collections.ICollection)">
  1466. <summary>
  1467. Remove all the specified elements from this set, if they exist in this set.
  1468. </summary>
  1469. <param name="c">A collection of elements to remove.</param>
  1470. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  1471. </member>
  1472. <member name="M:Iesi.Collections.DictionarySet.RetainAll(System.Collections.ICollection)">
  1473. <summary>
  1474. Retains only the elements in this set that are contained in the specified collection.
  1475. </summary>
  1476. <param name="c">Collection that defines the set of elements to be retained.</param>
  1477. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  1478. </member>
  1479. <member name="M:Iesi.Collections.DictionarySet.CopyTo(System.Array,System.Int32)">
  1480. <summary>
  1481. Copies the elements in the <c>Set</c> to an array. The type of array needs
  1482. to be compatible with the objects in the <c>Set</c>, obviously.
  1483. </summary>
  1484. <param name="array">An array that will be the target of the copy operation.</param>
  1485. <param name="index">The zero-based index where copying will start.</param>
  1486. </member>
  1487. <member name="M:Iesi.Collections.DictionarySet.GetEnumerator">
  1488. <summary>
  1489. Gets an enumerator for the elements in the <c>Set</c>.
  1490. </summary>
  1491. <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
  1492. </member>
  1493. <member name="P:Iesi.Collections.DictionarySet.Placeholder">
  1494. <summary>
  1495. The placeholder object used as the value for the <c>IDictionary</c> instance.
  1496. </summary>
  1497. <remarks>
  1498. There is a single instance of this object globally, used for all <c>Sets</c>.
  1499. </remarks>
  1500. </member>
  1501. <member name="P:Iesi.Collections.DictionarySet.IsEmpty">
  1502. <summary>
  1503. Returns <see langword="true" /> if this set contains no elements.
  1504. </summary>
  1505. </member>
  1506. <member name="P:Iesi.Collections.DictionarySet.Count">
  1507. <summary>
  1508. The number of elements contained in this collection.
  1509. </summary>
  1510. </member>
  1511. <member name="P:Iesi.Collections.DictionarySet.IsSynchronized">
  1512. <summary>
  1513. None of the objects based on <c>DictionarySet</c> are synchronized. Use the
  1514. <c>SyncRoot</c> property instead.
  1515. </summary>
  1516. </member>
  1517. <member name="P:Iesi.Collections.DictionarySet.SyncRoot">
  1518. <summary>
  1519. Returns an object that can be used to synchronize the <c>Set</c> between threads.
  1520. </summary>
  1521. </member>
  1522. <member name="T:Iesi.Collections.HashedSet">
  1523. <summary>
  1524. Implements a <c>Set</c> based on a hash table. This will give the best lookup, add, and remove
  1525. performance for very large data-sets, but iteration will occur in no particular order.
  1526. </summary>
  1527. </member>
  1528. <member name="M:Iesi.Collections.HashedSet.#ctor">
  1529. <summary>
  1530. Creates a new set instance based on a hash table.
  1531. </summary>
  1532. </member>
  1533. <member name="M:Iesi.Collections.HashedSet.#ctor(System.Collections.ICollection)">
  1534. <summary>
  1535. Creates a new set instance based on a hash table and
  1536. initializes it based on a collection of elements.
  1537. </summary>
  1538. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  1539. </member>
  1540. <member name="T:Iesi.Collections.HybridSet">
  1541. <summary>
  1542. Implements a <c>Set</c> that automatically changes from a list to a hash table
  1543. when the size reaches a certain threshold. This is good if you are unsure about
  1544. whether you data-set will be tiny or huge. Because this uses a dual implementation,
  1545. iteration order is not guaranteed!
  1546. </summary>
  1547. </member>
  1548. <member name="M:Iesi.Collections.HybridSet.#ctor">
  1549. <summary>
  1550. Creates a new set instance based on either a list or a hash table, depending on which
  1551. will be more efficient based on the data-set size.
  1552. </summary>
  1553. </member>
  1554. <member name="M:Iesi.Collections.HybridSet.#ctor(System.Collections.ICollection)">
  1555. <summary>
  1556. Creates a new set instance based on either a list or a hash table, depending on which
  1557. will be more efficient based on the data-set size, and
  1558. initializes it based on a collection of elements.
  1559. </summary>
  1560. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  1561. </member>
  1562. <member name="T:Iesi.Collections.ImmutableSet">
  1563. <summary>
  1564. <p>Implements an immutable (read-only) <c>Set</c> wrapper.</p>
  1565. <p>Although this is advertised as immutable, it really isn't. Anyone with access to the
  1566. <c>basisSet</c> can still change the data-set. So <c>GetHashCode()</c> is not implemented
  1567. for this <c>Set</c>, as is the case for all <c>Set</c> implementations in this library.
  1568. This design decision was based on the efficiency of not having to <c>Clone()</c> the
  1569. <c>basisSet</c> every time you wrap a mutable <c>Set</c>.</p>
  1570. </summary>
  1571. </member>
  1572. <member name="M:Iesi.Collections.ImmutableSet.#ctor(Iesi.Collections.ISet)">
  1573. <summary>
  1574. Constructs an immutable (read-only) <c>Set</c> wrapper.
  1575. </summary>
  1576. <param name="basisSet">The <c>Set</c> that is wrapped.</param>
  1577. </member>
  1578. <member name="M:Iesi.Collections.ImmutableSet.Add(System.Object)">
  1579. <summary>
  1580. Adds the specified element to this set if it is not already present.
  1581. </summary>
  1582. <param name="o">The object to add to the set.</param>
  1583. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  1584. </member>
  1585. <member name="M:Iesi.Collections.ImmutableSet.AddAll(System.Collections.ICollection)">
  1586. <summary>
  1587. Adds all the elements in the specified collection to the set if they are not already present.
  1588. </summary>
  1589. <param name="c">A collection of objects to add to the set.</param>
  1590. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  1591. </member>
  1592. <member name="M:Iesi.Collections.ImmutableSet.Clear">
  1593. <summary>
  1594. Removes all objects from the set.
  1595. </summary>
  1596. </member>
  1597. <member name="M:Iesi.Collections.ImmutableSet.Contains(System.Object)">
  1598. <summary>
  1599. Returns <see langword="true" /> if this set contains the specified element.
  1600. </summary>
  1601. <param name="o">The element to look for.</param>
  1602. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  1603. </member>
  1604. <member name="M:Iesi.Collections.ImmutableSet.ContainsAll(System.Collections.ICollection)">
  1605. <summary>
  1606. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  1607. </summary>
  1608. <param name="c">A collection of objects.</param>
  1609. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  1610. </member>
  1611. <member name="M:Iesi.Collections.ImmutableSet.Remove(System.Object)">
  1612. <summary>
  1613. Removes the specified element from the set.
  1614. </summary>
  1615. <param name="o">The element to be removed.</param>
  1616. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  1617. </member>
  1618. <member name="M:Iesi.Collections.ImmutableSet.RemoveAll(System.Collections.ICollection)">
  1619. <summary>
  1620. Remove all the specified elements from this set, if they exist in this set.
  1621. </summary>
  1622. <param name="c">A collection of elements to remove.</param>
  1623. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  1624. </member>
  1625. <member name="M:Iesi.Collections.ImmutableSet.RetainAll(System.Collections.ICollection)">
  1626. <summary>
  1627. Retains only the elements in this set that are contained in the specified collection.
  1628. </summary>
  1629. <param name="c">Collection that defines the set of elements to be retained.</param>
  1630. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  1631. </member>
  1632. <member name="M:Iesi.Collections.ImmutableSet.CopyTo(System.Array,System.Int32)">
  1633. <summary>
  1634. Copies the elements in the <c>Set</c> to an array. The type of array needs
  1635. to be compatible with the objects in the <c>Set</c>, obviously.
  1636. </summary>
  1637. <param name="array">An array that will be the target of the copy operation.</param>
  1638. <param name="index">The zero-based index where copying will start.</param>
  1639. </member>
  1640. <member name="M:Iesi.Collections.ImmutableSet.GetEnumerator">
  1641. <summary>
  1642. Gets an enumerator for the elements in the <c>Set</c>.
  1643. </summary>
  1644. <returns>An <c>IEnumerator</c> over the elements in the <c>Set</c>.</returns>
  1645. </member>
  1646. <member name="M:Iesi.Collections.ImmutableSet.Clone">
  1647. <summary>
  1648. Returns a clone of the <c>Set</c> instance.
  1649. </summary>
  1650. <returns>A clone of this object.</returns>
  1651. </member>
  1652. <member name="M:Iesi.Collections.ImmutableSet.Union(Iesi.Collections.ISet)">
  1653. <summary>
  1654. Performs a "union" of the two sets, where all the elements
  1655. in both sets are present. That is, the element is included if it is in either <c>a</c> or <c>b</c>.
  1656. Neither this set nor the input set are modified during the operation. The return value
  1657. is a <c>Clone()</c> of this set with the extra elements added in.
  1658. </summary>
  1659. <param name="a">A collection of elements.</param>
  1660. <returns>A new <c>Set</c> containing the union of this <c>Set</c> with the specified collection.
  1661. Neither of the input objects is modified by the union.</returns>
  1662. </member>
  1663. <member name="M:Iesi.Collections.ImmutableSet.Intersect(Iesi.Collections.ISet)">
  1664. <summary>
  1665. Performs an "intersection" of the two sets, where only the elements
  1666. that are present in both sets remain. That is, the element is included if it exists in
  1667. both sets. The <c>Intersect()</c> operation does not modify the input sets. It returns
  1668. a <c>Clone()</c> of this set with the appropriate elements removed.
  1669. </summary>
  1670. <param name="a">A set of elements.</param>
  1671. <returns>The intersection of this set with <c>a</c>.</returns>
  1672. </member>
  1673. <member name="M:Iesi.Collections.ImmutableSet.Minus(Iesi.Collections.ISet)">
  1674. <summary>
  1675. Performs a "minus" of set <c>b</c> from set <c>a</c>. This returns a set of all
  1676. the elements in set <c>a</c>, removing the elements that are also in set <c>b</c>.
  1677. The original sets are not modified during this operation. The result set is a <c>Clone()</c>
  1678. of this <c>Set</c> containing the elements from the operation.
  1679. </summary>
  1680. <param name="a">A set of elements.</param>
  1681. <returns>A set containing the elements from this set with the elements in <c>a</c> removed.</returns>
  1682. </member>
  1683. <member name="M:Iesi.Collections.ImmutableSet.ExclusiveOr(Iesi.Collections.ISet)">
  1684. <summary>
  1685. Performs an "exclusive-or" of the two sets, keeping only the elements that
  1686. are in one of the sets, but not in both. The original sets are not modified
  1687. during this operation. The result set is a <c>Clone()</c> of this set containing
  1688. the elements from the exclusive-or operation.
  1689. </summary>
  1690. <param name="a">A set of elements.</param>
  1691. <returns>A set containing the result of <c>a ^ b</c>.</returns>
  1692. </member>
  1693. <member name="P:Iesi.Collections.ImmutableSet.IsEmpty">
  1694. <summary>
  1695. Returns <see langword="true" /> if this set contains no elements.
  1696. </summary>
  1697. </member>
  1698. <member name="P:Iesi.Collections.ImmutableSet.Count">
  1699. <summary>
  1700. The number of elements contained in this collection.
  1701. </summary>
  1702. </member>
  1703. <member name="P:Iesi.Collections.ImmutableSet.IsSynchronized">
  1704. <summary>
  1705. Returns an object that can be used to synchronize use of the <c>Set</c> across threads.
  1706. </summary>
  1707. </member>
  1708. <member name="P:Iesi.Collections.ImmutableSet.SyncRoot">
  1709. <summary>
  1710. Returns an object that can be used to synchronize the <c>Set</c> between threads.
  1711. </summary>
  1712. </member>
  1713. <member name="T:Iesi.Collections.ListSet">
  1714. <summary>
  1715. Implements a <c>Set</c> based on a list. Performance is much better for very small lists
  1716. than either <c>HashedSet</c> or <c>SortedSet</c>. However, performance degrades rapidly as
  1717. the data-set gets bigger. Use a <c>HybridSet</c> instead if you are not sure your data-set
  1718. will always remain very small. Iteration produces elements in the order they were added.
  1719. However, element order is not guaranteed to be maintained by the various <c>Set</c>
  1720. mathematical operators.
  1721. </summary>
  1722. </member>
  1723. <member name="M:Iesi.Collections.ListSet.#ctor">
  1724. <summary>
  1725. Creates a new set instance based on a list.
  1726. </summary>
  1727. </member>
  1728. <member name="M:Iesi.Collections.ListSet.#ctor(System.Collections.ICollection)">
  1729. <summary>
  1730. Creates a new set instance based on a list and
  1731. initializes it based on a collection of elements.
  1732. </summary>
  1733. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  1734. </member>
  1735. <member name="T:Iesi.Collections.SortedSet">
  1736. <summary>
  1737. Implements a set based on a sorted tree. This gives good performance for operations on very
  1738. large data-sets, though not as good - asymptotically - as a <see cref="T:Iesi.Collections.HashedSet"/>.
  1739. However, iteration occurs in order. Elements that you put into this type of collection must
  1740. implement <see cref="T:System.IComparable"/>, and they must actually be comparable. You can't mix
  1741. <see cref="T:System.String"/> and <see cref="T:System.Int32"/> values, for example.
  1742. </summary>
  1743. </member>
  1744. <member name="M:Iesi.Collections.SortedSet.#ctor">
  1745. <summary>
  1746. Creates a new set instance based on a sorted tree.
  1747. </summary>
  1748. </member>
  1749. <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.IComparer)">
  1750. <summary>
  1751. Creates a new set instance based on a sorted tree.
  1752. </summary>
  1753. <param name="comparer">The <see cref="T:System.Collections.IComparer"/> to use for sorting.</param>
  1754. </member>
  1755. <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.ICollection)">
  1756. <summary>
  1757. Creates a new set instance based on a sorted tree and
  1758. initializes it based on a collection of elements.
  1759. </summary>
  1760. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  1761. </member>
  1762. <member name="M:Iesi.Collections.SortedSet.#ctor(System.Collections.ICollection,System.Collections.IComparer)">
  1763. <summary>
  1764. Creates a new set instance based on a sorted tree and
  1765. initializes it based on a collection of elements.
  1766. </summary>
  1767. <param name="initialValues">A collection of elements that defines the initial set contents.</param>
  1768. <param name="comparer">The <see cref="T:System.Collections.IComparer"/> to use for sorting.</param>
  1769. </member>
  1770. <member name="T:Iesi.Collections.SynchronizedSet">
  1771. <summary>
  1772. Implements a thread-safe <see cref="T:Iesi.Collections.ISet"/> wrapper.
  1773. </summary>
  1774. <remarks>
  1775. The implementation is extremely conservative, serializing critical sections
  1776. to prevent possible deadlocks, and locking on everything. The one exception
  1777. is for enumeration, which is inherently not thread-safe. For this, you have
  1778. to <see langword="lock"/> the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/> object for the duration
  1779. of the enumeration.
  1780. </remarks>
  1781. </member>
  1782. <member name="M:Iesi.Collections.SynchronizedSet.#ctor(Iesi.Collections.ISet)">
  1783. <summary>
  1784. Constructs a thread-safe <see cref="T:Iesi.Collections.ISet"/> wrapper.
  1785. </summary>
  1786. <param name="basisSet">The <see cref="T:Iesi.Collections.ISet"/> object that this object will wrap.</param>
  1787. </member>
  1788. <member name="M:Iesi.Collections.SynchronizedSet.Add(System.Object)">
  1789. <summary>
  1790. Adds the specified element to this set if it is not already present.
  1791. </summary>
  1792. <param name="o">The object to add to the set.</param>
  1793. <returns><see langword="true" /> is the object was added, <see langword="false" /> if it was already present.</returns>
  1794. </member>
  1795. <member name="M:Iesi.Collections.SynchronizedSet.AddAll(System.Collections.ICollection)">
  1796. <summary>
  1797. Adds all the elements in the specified collection to the set if they are not already present.
  1798. </summary>
  1799. <param name="c">A collection of objects to add to the set.</param>
  1800. <returns><see langword="true" /> is the set changed as a result of this operation, <see langword="false" /> if not.</returns>
  1801. </member>
  1802. <member name="M:Iesi.Collections.SynchronizedSet.Clear">
  1803. <summary>
  1804. Removes all objects from the set.
  1805. </summary>
  1806. </member>
  1807. <member name="M:Iesi.Collections.SynchronizedSet.Contains(System.Object)">
  1808. <summary>
  1809. Returns <see langword="true" /> if this set contains the specified element.
  1810. </summary>
  1811. <param name="o">The element to look for.</param>
  1812. <returns><see langword="true" /> if this set contains the specified element, <see langword="false" /> otherwise.</returns>
  1813. </member>
  1814. <member name="M:Iesi.Collections.SynchronizedSet.ContainsAll(System.Collections.ICollection)">
  1815. <summary>
  1816. Returns <see langword="true" /> if the set contains all the elements in the specified collection.
  1817. </summary>
  1818. <param name="c">A collection of objects.</param>
  1819. <returns><see langword="true" /> if the set contains all the elements in the specified collection, <see langword="false" /> otherwise.</returns>
  1820. </member>
  1821. <member name="M:Iesi.Collections.SynchronizedSet.Remove(System.Object)">
  1822. <summary>
  1823. Removes the specified element from the set.
  1824. </summary>
  1825. <param name="o">The element to be removed.</param>
  1826. <returns><see langword="true" /> if the set contained the specified element, <see langword="false" /> otherwise.</returns>
  1827. </member>
  1828. <member name="M:Iesi.Collections.SynchronizedSet.RemoveAll(System.Collections.ICollection)">
  1829. <summary>
  1830. Remove all the specified elements from this set, if they exist in this set.
  1831. </summary>
  1832. <param name="c">A collection of elements to remove.</param>
  1833. <returns><see langword="true" /> if the set was modified as a result of this operation.</returns>
  1834. </member>
  1835. <member name="M:Iesi.Collections.SynchronizedSet.RetainAll(System.Collections.ICollection)">
  1836. <summary>
  1837. Retains only the elements in this set that are contained in the specified collection.
  1838. </summary>
  1839. <param name="c">Collection that defines the set of elements to be retained.</param>
  1840. <returns><see langword="true" /> if this set changed as a result of this operation.</returns>
  1841. </member>
  1842. <member name="M:Iesi.Collections.SynchronizedSet.CopyTo(System.Array,System.Int32)">
  1843. <summary>
  1844. Copies the elements in the set to an array. The type of array needs
  1845. to be compatible with the objects in the set, obviously.
  1846. </summary>
  1847. <param name="array">An array that will be the target of the copy operation.</param>
  1848. <param name="index">The zero-based index where copying will start.</param>
  1849. </member>
  1850. <member name="M:Iesi.Collections.SynchronizedSet.GetEnumerator">
  1851. <summary>
  1852. Returns an enumerator that iterates through the set.
  1853. </summary>
  1854. <returns>
  1855. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the set.
  1856. </returns>
  1857. <remarks>
  1858. Enumeration is, by definition, not thread-safe. Use a <see langword="lock"/> on the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/>
  1859. to synchronize the entire enumeration process.
  1860. </remarks>
  1861. </member>
  1862. <member name="M:Iesi.Collections.SynchronizedSet.Clone">
  1863. <summary>
  1864. Returns a clone of this instance.
  1865. </summary>
  1866. <returns>A clone of this object.</returns>
  1867. </member>
  1868. <member name="P:Iesi.Collections.SynchronizedSet.IsEmpty">
  1869. <summary>
  1870. Returns <see langword="true" /> if this set contains no elements.
  1871. </summary>
  1872. </member>
  1873. <member name="P:Iesi.Collections.SynchronizedSet.Count">
  1874. <summary>
  1875. The number of elements contained in this collection.
  1876. </summary>
  1877. </member>
  1878. <member name="P:Iesi.Collections.SynchronizedSet.IsSynchronized">
  1879. <summary>
  1880. Returns <see langword="true"/>, indicating that this object is thread-safe. The exception to this
  1881. is enumeration, which is inherently not thread-safe. Use the <see cref="P:Iesi.Collections.SynchronizedSet.SyncRoot"/> object to
  1882. lock this object for the entire duration of the enumeration.
  1883. </summary>
  1884. </member>
  1885. <member name="P:Iesi.Collections.SynchronizedSet.SyncRoot">
  1886. <summary>
  1887. Returns an object that can be used to synchronize the set between threads.
  1888. </summary>
  1889. </member>
  1890. </members>
  1891. </doc>