PageRenderTime 73ms CodeModel.GetById 25ms RepoModel.GetById 2ms app.codeStats 0ms

/Dlls/Delta.Utilities.Collections.xml

#
XML | 1458 lines | 1457 code | 1 blank | 0 comment | 0 complexity | a104821e784d9ec9b3d9fb749ae152eb MD5 | raw file
Possible License(s): Apache-2.0

Large files files are truncated, but you can click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.Utilities.Collections</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.Utilities.Collections.Hash`1">
  8. <summary>
  9. The base implementation for various collections classes that use hash
  10. tables as part of their implementation. This class should not (and can
  11. not) be used directly by end users; it's only for internal use by the
  12. collections package. The Hash does not handle duplicate values.
  13. </summary>
  14. <remarks>
  15. The Hash manages items of type T, and uses a IComparer&lt;ItemTYpe&gt;
  16. that hashes compares items to hash items into the table.
  17. </remarks>
  18. <typeparam name="T">Data type</typeparam>
  19. </member>
  20. <member name="F:Delta.Utilities.Collections.Hash`1.equalityComparer">
  21. <summary>
  22. Interface for comparing elements
  23. </summary>
  24. <typeparam name="T">T</typeparam>
  25. </member>
  26. <member name="F:Delta.Utilities.Collections.Hash`1.count">
  27. <summary>
  28. Count
  29. </summary>
  30. <typeparam name="T">T</typeparam>
  31. <summary>
  32. The count of elements in the table.
  33. </summary>
  34. </member>
  35. <member name="F:Delta.Utilities.Collections.Hash`1.usedSlots">
  36. <summary>
  37. Includes real elements and deleted elements with the collision bit on.
  38. Used to determine when we need to resize.
  39. </summary>
  40. <typeparam name="T">T</typeparam>
  41. </member>
  42. <member name="F:Delta.Utilities.Collections.Hash`1.totalSlots">
  43. <summary>
  44. Size of the table. Always a power of two.
  45. </summary>
  46. <typeparam name="T">T</typeparam>
  47. </member>
  48. <member name="F:Delta.Utilities.Collections.Hash`1.loadFactor">
  49. <summary>
  50. maximal load factor for the table.
  51. </summary>
  52. <typeparam name="T">T</typeparam>
  53. </member>
  54. <member name="F:Delta.Utilities.Collections.Hash`1.thresholdGrow">
  55. <summary>
  56. floor(totalSlots * loadFactor);
  57. </summary>
  58. <typeparam name="T">T</typeparam>
  59. </member>
  60. <member name="F:Delta.Utilities.Collections.Hash`1.thresholdShrink">
  61. <summary>
  62. thresholdGrow / 3.
  63. </summary>
  64. <typeparam name="T">T</typeparam>
  65. </member>
  66. <member name="F:Delta.Utilities.Collections.Hash`1.hashMask">
  67. <summary>
  68. Table
  69. </summary>
  70. <typeparam name="T">T</typeparam>
  71. <summary>
  72. Mask to convert hash values to the size of the table.
  73. </summary>
  74. </member>
  75. <member name="F:Delta.Utilities.Collections.Hash`1.secondaryShift">
  76. <summary>
  77. Shift to get the secondary skip value.
  78. </summary>
  79. <typeparam name="T">T</typeparam>
  80. </member>
  81. <member name="F:Delta.Utilities.Collections.Hash`1.table">
  82. <summary>
  83. The hash table.
  84. </summary>
  85. <typeparam name="T">T</typeparam>
  86. </member>
  87. <member name="F:Delta.Utilities.Collections.Hash`1.changeStamp">
  88. <summary>
  89. An integer that is changed every time the table structurally changes.
  90. Used so that enumerations throw an exception if the tree is changed
  91. during enumeration.
  92. </summary>
  93. <typeparam name="T">T</typeparam>
  94. </member>
  95. <member name="F:Delta.Utilities.Collections.Hash`1.serializationInfo">
  96. <summary>
  97. Info used during deserialization.
  98. </summary>
  99. <typeparam name="T">T</typeparam>
  100. </member>
  101. <member name="M:Delta.Utilities.Collections.Hash`1.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
  102. <summary>
  103. Constructor. Create a new hash table.
  104. </summary>
  105. <param name="equalityComparer">The comparer to use to compare items.
  106. </param>
  107. </member>
  108. <member name="M:Delta.Utilities.Collections.Hash`1.GetEnumerationStamp">
  109. <summary>
  110. Gets the current enumeration stamp. Call CheckEnumerationStamp later
  111. with this value to throw an exception if the hash table is changed.
  112. </summary>
  113. <returns>The current enumeration stamp.</returns>
  114. </member>
  115. <member name="M:Delta.Utilities.Collections.Hash`1.StopEnumerations">
  116. <summary>
  117. Must be called whenever there is a structural change in the tree.
  118. Causes changeStamp to be changed, which causes any in-progress
  119. enumerations to throw exceptions.
  120. </summary>
  121. </member>
  122. <member name="M:Delta.Utilities.Collections.Hash`1.CheckEnumerationStamp(System.Int32)">
  123. <summary>
  124. Checks the given stamp against the current change stamp. If different,
  125. the collection has changed during enumeration and an
  126. InvalidOperationException must be thrown
  127. </summary>
  128. <param name="startStamp">changeStamp at the start of the enumeration.
  129. </param>
  130. </member>
  131. <member name="M:Delta.Utilities.Collections.Hash`1.GetEnumerator">
  132. <summary>
  133. Enumerate all of the items in the hash table. The items
  134. are enumerated in a haphazard, unpredictable order.
  135. </summary>
  136. <returns>An IEnumerator&lt;T&gt; that enumerates the items
  137. in the hash table.</returns>
  138. </member>
  139. <member name="M:Delta.Utilities.Collections.Hash`1.System#Collections#IEnumerable#GetEnumerator">
  140. <summary>
  141. Enumerate all of the items in the hash table. The items
  142. are enumerated in a haphazard, unpredictable order.
  143. </summary>
  144. <returns>An IEnumerator that enumerates the items
  145. in the hash table.</returns>
  146. </member>
  147. <member name="M:Delta.Utilities.Collections.Hash`1.GetFullHash(`0)">
  148. <summary>
  149. Gets the full hash code for an item.
  150. </summary>
  151. <param name="item">Item to get hash code for.</param>
  152. <returns>The full hash code. It is never zero.</returns>
  153. </member>
  154. <member name="M:Delta.Utilities.Collections.Hash`1.GetHashValuesFromFullHash(System.Int32,System.Int32@,System.Int32@)">
  155. <summary>
  156. Get the initial bucket number and skip amount from the full hash value.
  157. </summary>
  158. <param name="hash">The full hash value.</param>
  159. <param name="initialBucket">Returns the initial bucket. Always in the
  160. range 0..(totalSlots - 1).</param>
  161. <param name="skip">Returns the skip values. Always odd in the range
  162. 0..(totalSlots - 1).</param>
  163. </member>
  164. <member name="M:Delta.Utilities.Collections.Hash`1.GetHashValues(`0,System.Int32@,System.Int32@)">
  165. <summary>
  166. Gets the full hash value, initial bucket number, and skip amount for an
  167. item.
  168. </summary>
  169. <param name="item">Item to get hash value of.</param>
  170. <param name="initialBucket">Returns the initial bucket. Always in the
  171. range 0..(totalSlots - 1).</param>
  172. <param name="skip">Returns the skip values. Always odd in the range
  173. 0..(totalSlots - 1).</param>
  174. <returns>The full hash value. This is never zero.</returns>
  175. </member>
  176. <member name="M:Delta.Utilities.Collections.Hash`1.EnsureEnoughSlots(System.Int32)">
  177. <summary>
  178. Make sure there are enough slots in the hash table that
  179. <paramref name="additionalItems"/> items can be inserted into the
  180. table.
  181. </summary>
  182. <param name="additionalItems">Number of additional items we are
  183. inserting.</param>
  184. </member>
  185. <member name="M:Delta.Utilities.Collections.Hash`1.ShrinkIfNeeded">
  186. <summary>
  187. Check if the number of items in the table is small enough that
  188. we should shrink the table again.
  189. </summary>
  190. </member>
  191. <member name="M:Delta.Utilities.Collections.Hash`1.GetSecondaryShift(System.Int32)">
  192. <summary>
  193. Given the size of a hash table, compute the "secondary shift" value.
  194. The shift that is used to determine the skip amount for collision
  195. resolution.
  196. </summary>
  197. <param name="newSize">The new size of the table.</param>
  198. <returns>The secondary skip amount.</returns>
  199. </member>
  200. <member name="M:Delta.Utilities.Collections.Hash`1.ResizeTable(System.Int32)">
  201. <summary>
  202. Resize the hash table to the given new size, moving all items into the
  203. new hash table.
  204. </summary>
  205. <param name="newSize">The new size of the hash table. Must be a power
  206. of two.</param>
  207. </member>
  208. <member name="M:Delta.Utilities.Collections.Hash`1.Insert(`0,System.Boolean,`0@)">
  209. <summary>
  210. Insert a new item into the hash table. If a duplicate item exists,
  211. can replace or do nothing.
  212. </summary>
  213. <param name="item">The item to insert.</param>
  214. <param name="replaceOnDuplicate">If true, duplicate items are replaced.
  215. If false, nothing is done if a duplicate already exists.</param>
  216. <param name="previous">If a duplicate was found, returns it (whether
  217. replaced or not).</param>
  218. <returns>True if no duplicate existed, false if a duplicate was found.
  219. </returns>
  220. </member>
  221. <member name="M:Delta.Utilities.Collections.Hash`1.Delete(`0,`0@)">
  222. <summary>
  223. Deletes an item from the hash table.
  224. </summary>
  225. <param name="item">Item to search for and delete.</param>
  226. <param name="itemDeleted">If true returned, the actual item stored in
  227. the hash table (must be equal to <paramref name="item"/>, but may not
  228. be identical.</param>
  229. <returns>True if item was found and deleted, false if item wasn't
  230. found.</returns>
  231. </member>
  232. <member name="M:Delta.Utilities.Collections.Hash`1.Find(`0,System.Boolean,`0@)">
  233. <summary>
  234. Find an item in the hash table. If found, optionally replace it with
  235. the finding item.
  236. </summary>
  237. <param name="find">Item to find.</param>
  238. <param name="replace">If true, replaces the equal item in the hash
  239. table with <paramref name="item"/>.</param>
  240. <param name="item">Returns the equal item found in the table, if true
  241. was returned.</param>
  242. <returns>True if the item was found, false otherwise.</returns>
  243. </member>
  244. <member name="M:Delta.Utilities.Collections.Hash`1.Clone(System.Converter{`0,`0})">
  245. <summary>
  246. Creates a clone of this hash table.
  247. </summary>
  248. <param name="cloneItem">If non-null, this function is applied to each
  249. item when cloning. It must be the case that this function does not
  250. modify the hash code or equality function.</param>
  251. <returns>A shallow clone that contains the same items.</returns>
  252. </member>
  253. <member name="M:Delta.Utilities.Collections.Hash`1.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  254. <summary>
  255. Serialize the hash table. Called from the serialization infrastructure.
  256. </summary>
  257. <param name="context">Context</param>
  258. <param name="info">Info</param>
  259. </member>
  260. <member name="M:Delta.Utilities.Collections.Hash`1.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  261. <summary>
  262. Called on deserialization. We cannot deserialize now, because hash
  263. codes might not be correct now. We do real deserialization in the
  264. OnDeserialization call.
  265. </summary>
  266. <param name="context">Context</param>
  267. <param name="serInfo">serInfo</param>
  268. </member>
  269. <member name="M:Delta.Utilities.Collections.Hash`1.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization(System.Object)">
  270. <summary>
  271. Deserialize the hash table. Called from the serialization
  272. infrastructure when the object graph has finished deserializing.
  273. </summary>
  274. <param name="sender">sender</param>
  275. </member>
  276. <member name="M:Delta.Utilities.Collections.Hash`1.ToString">
  277. <summary>
  278. To string
  279. </summary>
  280. <returns>String</returns>
  281. </member>
  282. <member name="P:Delta.Utilities.Collections.Hash`1.ElementCount">
  283. <summary>
  284. Get the number of items in the hash table.
  285. </summary>
  286. <typeparam name="T">T</typeparam>
  287. <value>The number of items stored in the hash table.</value>
  288. </member>
  289. <member name="P:Delta.Utilities.Collections.Hash`1.SlotCount">
  290. <summary>
  291. Get the number of slots in the hash table. Exposed internally
  292. for testing purposes.
  293. </summary>
  294. <typeparam name="T">T</typeparam>
  295. <value>The number of slots in the hash table.</value>
  296. </member>
  297. <member name="P:Delta.Utilities.Collections.Hash`1.LoadFactor">
  298. <summary>
  299. Get or change the load factor. Changing the load factor may cause
  300. the size of the table to grow or shrink accordingly.
  301. </summary>
  302. <typeparam name="T">T</typeparam>
  303. <value></value>
  304. </member>
  305. <member name="T:Delta.Utilities.Collections.Hash`1.Slot">
  306. <summary>
  307. The structure that has each slot in the hash table. Each slot has three
  308. parts:
  309. 1. The collision bit. Indicates whether some item visited this slot but
  310. had to keep looking because the slot was full.
  311. 2. 31-bit full hash value of the item. If zero, the slot is empty.
  312. 3. The item itself.
  313. </summary>
  314. </member>
  315. <member name="F:Delta.Utilities.Collections.Hash`1.Slot.item">
  316. <summary>
  317. </summary>
  318. <summary>
  319. The item.
  320. </summary>
  321. </member>
  322. <member name="F:Delta.Utilities.Collections.Hash`1.Slot.hash_collision">
  323. <summary>
  324. Lower 31 bits: the hash value. Top bit: the collision bit.
  325. </summary>
  326. </member>
  327. <member name="M:Delta.Utilities.Collections.Hash`1.Slot.Clear">
  328. <summary>
  329. Clear this slot, leaving the collision bit alone.
  330. </summary>
  331. </member>
  332. <member name="M:Delta.Utilities.Collections.Hash`1.Slot.ToString">
  333. <summary>
  334. To string
  335. </summary>
  336. <returns>String</returns>
  337. </member>
  338. <member name="P:Delta.Utilities.Collections.Hash`1.Slot.HashValue">
  339. <summary>
  340. The full hash value associated with the value in this slot, or zero
  341. if the slot is empty.
  342. </summary>
  343. </member>
  344. <member name="P:Delta.Utilities.Collections.Hash`1.Slot.Empty">
  345. <summary>
  346. Is this slot empty?
  347. </summary>
  348. </member>
  349. <member name="P:Delta.Utilities.Collections.Hash`1.Slot.Collision">
  350. <summary>
  351. The "Collision" bit indicates that some value hit this slot and
  352. collided, so had to try another slot.
  353. </summary>
  354. </member>
  355. <member name="T:Delta.Utilities.Collections.HashTests">
  356. <summary>
  357. Hash tests, needs to be an extra class because Hash is generic.
  358. </summary>
  359. </member>
  360. <member name="M:Delta.Utilities.Collections.HashTests.TestHash">
  361. <summary>
  362. Test hash. Note: Too slow for a dynamic unit test.
  363. </summary>
  364. </member>
  365. <member name="T:Delta.Utilities.Collections.PriorityQueue`1">
  366. <summary>
  367. Priority queue with generics.
  368. INFO: This is up to 3 times faster than the non generic version
  369. Delta.Utilities.Collections.PriorityQueue.cs, Benchmark results:
  370. 1000 times adding 500 elements and popping them:
  371. BinaryPriorityQueue: 403,76ms (32,6%)
  372. PriorityQueue: 429,24ms (34,6%)
  373. PriorityQueuePoint: 197,88ms (16%)
  374. PriorityQueue with generics (this class): 208,5ms (16,8%)
  375. <para />
  376. This class is way more flexible than fixed class for just one type like
  377. the PriorityQueuePoint class, optimized for a Point structure. Generics
  378. are good enough to avoid these special case classes.
  379. </summary>
  380. </member>
  381. <member name="T:Delta.Utilities.Collections.ICloneable`1">
  382. <summary>
  383. Generic interface for cloning objects. We put this in the System
  384. namespace to make sure it is always loaded.
  385. </summary>
  386. <typeparam name="T">Data type</typeparam>
  387. </member>
  388. <member name="M:Delta.Utilities.Collections.ICloneable`1.Clone">
  389. <summary>
  390. Clones the object.
  391. </summary>
  392. </member>
  393. <member name="F:Delta.Utilities.Collections.PriorityQueue`1.numOfElements">
  394. <summary>
  395. Number of elements
  396. </summary>
  397. </member>
  398. <member name="F:Delta.Utilities.Collections.PriorityQueue`1.data">
  399. <summary>
  400. Data
  401. </summary>
  402. <typeparam name="T">T</typeparam>
  403. </member>
  404. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.#ctor(`0[])">
  405. <summary>
  406. Create priority queue
  407. </summary>
  408. </member>
  409. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.#ctor">
  410. <summary>
  411. Priority queue
  412. </summary>
  413. </member>
  414. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.Clone">
  415. <summary>
  416. Clone
  417. </summary>
  418. <returns>Clone</returns>
  419. </member>
  420. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.System#Collections#IEnumerable#GetEnumerator">
  421. <summary>
  422. System. collections. i enumerable. get enumerator
  423. </summary>
  424. <returns>System. collections. i enumerator</returns>
  425. </member>
  426. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.GetEnumerator">
  427. <summary>
  428. IEnumerator
  429. </summary>
  430. <returns>IEnumerator</returns>
  431. </member>
  432. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.Push(`0)">
  433. <summary>
  434. Push a new item to the priority queue.
  435. Could realloc memory if bigger size is required.
  436. </summary>
  437. <param name="newData">New Data</param>
  438. </member>
  439. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.Pop">
  440. <summary>
  441. Remove top entry (returns nothing, if you want to use top entry,
  442. just use pq.data[1])
  443. </summary>
  444. </member>
  445. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.Peek">
  446. <summary>
  447. Get the smallest object without removing it.
  448. </summary>
  449. <returns>The smalles object without removing it</returns>
  450. </member>
  451. <member name="M:Delta.Utilities.Collections.PriorityQueue`1.CopyTo(System.Array,System.Int32)">
  452. <summary>
  453. Copy to
  454. </summary>
  455. <param name="array">Array</param>
  456. <param name="index">Index</param>
  457. </member>
  458. <member name="P:Delta.Utilities.Collections.PriorityQueue`1.Count">
  459. <summary>
  460. Count, will NOT return numOfElements, because its 1-based.
  461. </summary>
  462. <typeparam name="T">T</typeparam>
  463. </member>
  464. <member name="P:Delta.Utilities.Collections.PriorityQueue`1.IsSynchronized">
  465. <summary>
  466. Is synchronized
  467. </summary>
  468. <typeparam name="T">T</typeparam>
  469. </member>
  470. <member name="P:Delta.Utilities.Collections.PriorityQueue`1.SyncRoot">
  471. <summary>
  472. Sync root
  473. </summary>
  474. <typeparam name="T">T</typeparam>
  475. </member>
  476. <member name="T:Delta.Utilities.Collections.PriorityQueueTests">
  477. <summary>
  478. PriorityQueue tests, must be decleared outside of a generic class.
  479. </summary>
  480. </member>
  481. <member name="M:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueueGenericPerformance">
  482. <summary>
  483. Test priority queue generic performance
  484. </summary>
  485. </member>
  486. <member name="M:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueue">
  487. <summary>
  488. Test PriorityQueue
  489. </summary>
  490. </member>
  491. <member name="T:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueuePointData">
  492. <summary>
  493. Test PriorityQueue helper class for Points
  494. </summary>
  495. </member>
  496. <member name="T:Delta.Utilities.Collections.IPriorityQueueData">
  497. <summary>
  498. Interface for priority queue data, used in PriorityQueue class!
  499. </summary>
  500. </member>
  501. <member name="P:Delta.Utilities.Collections.IPriorityQueueData.Priority">
  502. <summary>
  503. Get priority of item, everything will be sorted by this priority.
  504. </summary>
  505. </member>
  506. <member name="F:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueuePointData.pos">
  507. <summary>
  508. Position
  509. </summary>
  510. </member>
  511. <member name="F:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueuePointData.priority">
  512. <summary>
  513. Priority
  514. </summary>
  515. </member>
  516. <member name="M:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueuePointData.#ctor(Delta.Utilities.Datatypes.Point,System.Single)">
  517. <summary>
  518. Priority queue point data
  519. </summary>
  520. </member>
  521. <member name="P:Delta.Utilities.Collections.PriorityQueueTests.TestPriorityQueuePointData.Priority">
  522. <summary>
  523. Priority
  524. </summary>
  525. </member>
  526. <member name="T:Delta.Utilities.Collections.Dequeue`1">
  527. <summary>
  528. System.Collections conform class for a ring-queue.
  529. </summary>
  530. <remarks>
  531. The collection support adding and removing at both ends and automatic
  532. expansion. The left end of the ring is referred to as head, the right
  533. end as tail. Add / Remove needs always the same time, expansion takes
  534. more time, depending on the size. Indexed access and enumeration is fast.
  535. </remarks>
  536. </member>
  537. <member name="F:Delta.Utilities.Collections.Dequeue`1.innerList">
  538. <summary>
  539. Inner list for this dequeue
  540. </summary>
  541. <typeparam name="T">T</typeparam>
  542. </member>
  543. <member name="F:Delta.Utilities.Collections.Dequeue`1.growthFactor">
  544. <summary>
  545. Grow factor
  546. </summary>
  547. <typeparam name="T">T</typeparam>
  548. </member>
  549. <member name="F:Delta.Utilities.Collections.Dequeue`1.head">
  550. <summary>
  551. Head, tail and count of elements
  552. </summary>
  553. <typeparam name="T">T</typeparam>
  554. </member>
  555. <member name="F:Delta.Utilities.Collections.Dequeue`1.tail">
  556. <summary>
  557. Head, tail and count of elements
  558. </summary>
  559. <typeparam name="T">T</typeparam>
  560. </member>
  561. <member name="F:Delta.Utilities.Collections.Dequeue`1.count">
  562. <summary>
  563. Head, tail and count of elements
  564. </summary>
  565. <typeparam name="T">T</typeparam>
  566. </member>
  567. <member name="F:Delta.Utilities.Collections.Dequeue`1.version">
  568. <summary>
  569. Version, who needs that?
  570. </summary>
  571. <typeparam name="T">T</typeparam>
  572. </member>
  573. <member name="M:Delta.Utilities.Collections.Dequeue`1.#ctor">
  574. <summary>
  575. Create an empty Dequeue with capacity 32 and growth 2
  576. </summary>
  577. </member>
  578. <member name="M:Delta.Utilities.Collections.Dequeue`1.#ctor(System.Int32)">
  579. <summary>
  580. Create an empty Dequeue with given capacity and growth 2
  581. </summary>
  582. <param name="capacity">the initial capacity of the collection</param>
  583. </member>
  584. <member name="M:Delta.Utilities.Collections.Dequeue`1.#ctor(System.Int32,System.Double)">
  585. <summary>
  586. Create an empty Dequeue with given capacity and given growth
  587. </summary>
  588. <param name="capacity">The initial capacity of the collection</param>
  589. <param name="setGrowthFactor">The factor by which to grow the
  590. collection when the capacity is reached</param>
  591. </member>
  592. <member name="M:Delta.Utilities.Collections.Dequeue`1.#ctor(System.Collections.Generic.ICollection{`0})">
  593. <summary>
  594. Create a new Dequeue as a copy of the given collection
  595. </summary>
  596. <param name="collection">The source collection</param>
  597. </member>
  598. <member name="M:Delta.Utilities.Collections.Dequeue`1.#ctor(System.Collections.Generic.ICollection{`0},System.Int32)">
  599. <summary>
  600. Create a new Dequeue as a copy of the given collection and the
  601. given capacity.
  602. </summary>
  603. <param name="collection">The source collection</param>
  604. <param name="capacity">The capacity of the new Dequeue
  605. (must be bigger or equal as C.Count)</param>
  606. </member>
  607. <member name="M:Delta.Utilities.Collections.Dequeue`1.Clone">
  608. <summary>
  609. Standard implementation.
  610. </summary>
  611. <returns>A Dequeue with a shallow copy of this one.</returns>
  612. </member>
  613. <member name="M:Delta.Utilities.Collections.Dequeue`1.Add(`0)">
  614. <summary>
  615. Add. Not supported, do not call!
  616. </summary>
  617. <param name="item">Item to add</param>
  618. </member>
  619. <member name="M:Delta.Utilities.Collections.Dequeue`1.Clear">
  620. <summary>
  621. Deletes all entries from the collection
  622. </summary>
  623. </member>
  624. <member name="M:Delta.Utilities.Collections.Dequeue`1.Contains(`0)">
  625. <summary>
  626. Contains
  627. </summary>
  628. <param name="item">Item</param>
  629. <returns>True if the item was found, false otherwise.</returns>
  630. </member>
  631. <member name="M:Delta.Utilities.Collections.Dequeue`1.CopyTo(`0[],System.Int32)">
  632. <summary>
  633. Implementation of the ICollection.CopyTo function.
  634. </summary>
  635. <param name="array">Target array</param>
  636. <param name="arrayIndex">Start-Index in target array</param>
  637. </member>
  638. <member name="M:Delta.Utilities.Collections.Dequeue`1.Remove(`0)">
  639. <summary>
  640. Remove. Do not call, this is not implemented!
  641. </summary>
  642. <param name="item">Item</param>
  643. <returns>
  644. True if removing the item succeeded, false otherwise.
  645. </returns>
  646. </member>
  647. <member name="M:Delta.Utilities.Collections.Dequeue`1.System#Collections#IEnumerable#GetEnumerator">
  648. <summary>
  649. System. collections. i enumerable. get enumerator
  650. </summary>
  651. <returns>System. collections. i enumerator</returns>
  652. </member>
  653. <member name="M:Delta.Utilities.Collections.Dequeue`1.GetEnumerator">
  654. <summary>
  655. Standard implementation.
  656. </summary>
  657. <returns>A DequeueEnumerator on the current dequeue</returns>
  658. </member>
  659. <member name="M:Delta.Utilities.Collections.Dequeue`1.Equals(System.Collections.Generic.ICollection{`0})">
  660. <summary>
  661. Equals
  662. </summary>
  663. <param name="that">That</param>
  664. <returns>True if the other collection (that) is the same.</returns>
  665. </member>
  666. <member name="M:Delta.Utilities.Collections.Dequeue`1.ContainsCount(`0)">
  667. <summary>
  668. Contains count
  669. </summary>
  670. <param name="item">Item</param>
  671. <returns>Int</returns>
  672. </member>
  673. <member name="M:Delta.Utilities.Collections.Dequeue`1.ContainsAll(System.Collections.Generic.IEnumerable{`0})">
  674. <summary>
  675. Contains all
  676. </summary>
  677. <param name="items">Items to check</param>
  678. <returns>Returns true if all items are in this dequeue.</returns>
  679. </member>
  680. <member name="M:Delta.Utilities.Collections.Dequeue`1.Find(`0@)">
  681. <summary>
  682. Find. Do not call, this method is not implemented!
  683. </summary>
  684. <param name="item">Item</param>
  685. <returns>True if the item was found</returns>
  686. </member>
  687. <member name="M:Delta.Utilities.Collections.Dequeue`1.FindOrAdd(`0@)">
  688. <summary>
  689. Find or add. Do not call, this method is not implemented!
  690. </summary>
  691. <param name="item">Item</param>
  692. <returns>True if the item was found or could be added.</returns>
  693. </member>
  694. <member name="M:Delta.Utilities.Collections.Dequeue`1.Update(`0)">
  695. <summary>
  696. Update. Do not call, this method is not implemented!
  697. </summary>
  698. <param name="item">Item</param>
  699. <returns>True if the item was updated.</returns>
  700. </member>
  701. <member name="M:Delta.Utilities.Collections.Dequeue`1.UpdateOrAdd(`0)">
  702. <summary>
  703. Update or add. Do not call, this method is not implemented!
  704. </summary>
  705. <param name="item">Item</param>
  706. <returns>True if the item was updated or added.</returns>
  707. </member>
  708. <member name="M:Delta.Utilities.Collections.Dequeue`1.RemoveWithReturn(`0@)">
  709. <summary>
  710. Remove with return. Do not call, this method is not implemented!
  711. </summary>
  712. <param name="item">Item</param>
  713. <returns>True if the item was removed</returns>
  714. </member>
  715. <member name="M:Delta.Utilities.Collections.Dequeue`1.RemoveAllCopies(`0)">
  716. <summary>
  717. Remove all copies
  718. </summary>
  719. <param name="item">Item</param>
  720. </member>
  721. <member name="M:Delta.Utilities.Collections.Dequeue`1.RemoveAll(System.Collections.Generic.IEnumerable{`0})">
  722. <summary>
  723. Remove all
  724. </summary>
  725. <param name="items">Items</param>
  726. </member>
  727. <member name="M:Delta.Utilities.Collections.Dequeue`1.RetainAll(System.Collections.Generic.IEnumerable{`0})">
  728. <summary>
  729. Retain all
  730. </summary>
  731. <param name="items">Items</param>
  732. </member>
  733. <member name="M:Delta.Utilities.Collections.Dequeue`1.AddAll(System.Collections.Generic.IEnumerable{`0})">
  734. <summary>
  735. Add all
  736. </summary>
  737. <param name="items">Items</param>
  738. </member>
  739. <member name="M:Delta.Utilities.Collections.Dequeue`1.AddAll``1(System.Collections.Generic.IEnumerable{``0})">
  740. <summary>
  741. Add all
  742. </summary>
  743. <param name="items">Items</param>
  744. </member>
  745. <member name="M:Delta.Utilities.Collections.Dequeue`1.Check">
  746. <summary>
  747. Check the queue. Do not call, this method is not implemented!
  748. </summary>
  749. <returns>True if the check succeeded, false otherwise.</returns>
  750. </member>
  751. <member name="M:Delta.Utilities.Collections.Dequeue`1.ToArray">
  752. <summary>
  753. To array
  754. </summary>
  755. <returns>Filled array with the same data as this dequeue</returns>
  756. </member>
  757. <member name="M:Delta.Utilities.Collections.Dequeue`1.EnqueueHead(`0)">
  758. <summary>
  759. Add the given object to the collections head
  760. </summary>
  761. <param name="value">The object to enqueue</param>
  762. </member>
  763. <member name="M:Delta.Utilities.Collections.Dequeue`1.EnqueueTail(`0)">
  764. <summary>
  765. Add the given object to the collections tail
  766. </summary>
  767. <param name="value">The object to enqueue</param>
  768. </member>
  769. <member name="M:Delta.Utilities.Collections.Dequeue`1.DequeueHead">
  770. <summary>
  771. Retrieve and remove the current head
  772. </summary>
  773. <returns>The removed object</returns>
  774. </member>
  775. <member name="M:Delta.Utilities.Collections.Dequeue`1.DequeueTail">
  776. <summary>
  777. Retrieve and remove the current tail
  778. </summary>
  779. <returns>The removed object</returns>
  780. </member>
  781. <member name="M:Delta.Utilities.Collections.Dequeue`1.EnqueueTailRange(System.Collections.Generic.ICollection{`0})">
  782. <summary>
  783. Add the given collection to the dequeues tail
  784. </summary>
  785. <param name="collection">The source collection</param>
  786. </member>
  787. <member name="M:Delta.Utilities.Collections.Dequeue`1.EnqueueHeadRange(System.Collections.Generic.ICollection{`0})">
  788. <summary>
  789. Add the given collection to the dequeues head.
  790. To preserve the order in the collection, the entries are
  791. added in revers order.
  792. </summary>
  793. <param name="collection">The source collection</param>
  794. </member>
  795. <member name="M:Delta.Utilities.Collections.Dequeue`1.TrimToSize">
  796. <summary>
  797. Sets the capacity to Count.
  798. </summary>
  799. </member>
  800. <member name="M:Delta.Utilities.Collections.Dequeue`1.CopyTo(System.Array,System.Int32)">
  801. <summary>
  802. Implementation of the ICollection.CopyTo function.
  803. </summary>
  804. <param name="array">Target array</param>
  805. <param name="index">Start-Index in target array</param>
  806. </member>
  807. <member name="M:Delta.Utilities.Collections.Dequeue`1.SetSize(System.Int32)">
  808. <summary>
  809. Sets the collections capacity to newSize
  810. </summary>
  811. <param name="newSize">the new collection size
  812. (must be &gt;= Count)</param>
  813. </member>
  814. <member name="P:Delta.Utilities.Collections.Dequeue`1.IsReadOnly">
  815. <summary>
  816. Is read only? Will always return false.
  817. </summary>
  818. </member>
  819. <member name="P:Delta.Utilities.Collections.Dequeue`1.AllowsDuplicates">
  820. <summary>
  821. Allows duplicates? Will always return false.
  822. </summary>
  823. </member>
  824. <member name="P:Delta.Utilities.Collections.Dequeue`1.IsEmpty">
  825. <summary>
  826. Is empty? Will return true if we have at least one item.
  827. </summary>
  828. </member>
  829. <member name="P:Delta.Utilities.Collections.Dequeue`1.Item(System.Int32)">
  830. <summary>
  831. Indexed access to all elements currently in the collection.
  832. Indexing starts at 0 (head) and ends at Count-1 (tail).
  833. </summary>
  834. <returns>Item at this index</returns>
  835. </member>
  836. <member name="P:Delta.Utilities.Collections.Dequeue`1.GrowthFactor">
  837. <summary>
  838. The current factor by which to grow the collection in case of expansion
  839. </summary>
  840. <typeparam name="T">T</typeparam>
  841. </member>
  842. <member name="P:Delta.Utilities.Collections.Dequeue`1.Capacity">
  843. <summary>
  844. The current amount of cells available to the dequeue
  845. </summary>
  846. <typeparam name="T">T</typeparam>
  847. </member>
  848. <member name="P:Delta.Utilities.Collections.Dequeue`1.Version">
  849. <summary>
  850. The current version of the dequeue. The version is increased with every
  851. changing operation. The main use is to invalidate all IEnumerators.
  852. </summary>
  853. <typeparam name="T">T</typeparam>
  854. </member>
  855. <member name="P:Delta.Utilities.Collections.Dequeue`1.IsSynchronized">
  856. <summary>
  857. Returns true.
  858. </summary>
  859. <typeparam name="T">T</typeparam>
  860. </member>
  861. <member name="P:Delta.Utilities.Collections.Dequeue`1.Count">
  862. <summary>
  863. The current number of elements in the queue
  864. </summary>
  865. <typeparam name="T">T</typeparam>
  866. </member>
  867. <member name="P:Delta.Utilities.Collections.Dequeue`1.SyncRoot">
  868. <summary>
  869. Returns sync root for this dequeue, which is always this object.
  870. </summary>
  871. </member>
  872. <member name="T:Delta.Utilities.Collections.DequeueTests">
  873. <summary>
  874. Dequeue tests, needs to be an extra class because Dequeue is generic.
  875. </summary>
  876. </member>
  877. <member name="M:Delta.Utilities.Collections.DequeueTests.TestDequeueGenericPerformance">
  878. <summary>
  879. Test dequeue generic performance
  880. </summary>
  881. </member>
  882. <member name="M:Delta.Utilities.Collections.DequeueTests.TestEnqueueHead">
  883. <summary>
  884. Test enqueue head
  885. </summary>
  886. </member>
  887. <member name="M:Delta.Utilities.Collections.DequeueTests.TestEnqueueTail">
  888. <summary>
  889. Test enqueue tail
  890. </summary>
  891. </member>
  892. <member name="T:Delta.Utilities.Collections.TreeNodeCollection`1">
  893. <summary>
  894. Tree node collection
  895. </summary>
  896. <typeparam name="T">T</typeparam>
  897. </member>
  898. <member name="F:Delta.Utilities.Collections.TreeNodeCollection`1.mList">
  899. <summary>
  900. mList List
  901. </summary>
  902. <typeparam name="T">T</typeparam>
  903. </member>
  904. <member name="F:Delta.Utilities.Collections.TreeNodeCollection`1.mOwner">
  905. <summary>
  906. mOwner Node
  907. </summary>
  908. <typeparam name="T">T</typeparam>
  909. </member>
  910. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.#ctor(Delta.Utilities.Collections.TreeNode{`0})">
  911. <summary>
  912. Create tree node collection
  913. </summary>
  914. <param name="owner">owner</param>
  915. </member>
  916. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.System#Collections#IEnumerable#GetEnumerator">
  917. <summary>
  918. Standard implementation.
  919. </summary>
  920. <returns>A IEnumerator on the current tree node collection</returns>
  921. </member>
  922. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.GetEnumerator">
  923. <summary>
  924. Get enumerator
  925. </summary>
  926. <returns>IEnumerator</returns>
  927. </member>
  928. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.Add(Delta.Utilities.Collections.TreeNode{`0})">
  929. <summary>
  930. Add
  931. </summary>
  932. <param name="rhs">rhs</param>
  933. </member>
  934. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.Remove(Delta.Utilities.Collections.TreeNode{`0})">
  935. <summary>
  936. Remove
  937. </summary>
  938. <param name="rhs">rhs</param>
  939. </member>
  940. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.Contains(Delta.Utilities.Collections.TreeNode{`0})">
  941. <summary>
  942. Does this node contains the given node directly?
  943. </summary>
  944. <param name="rhs">rhs</param>
  945. <returns>True if the list contains the given node</returns>
  946. </member>
  947. <member name="M:Delta.Utilities.Collections.TreeNodeCollection`1.Clear">
  948. <summary>
  949. Clear
  950. </summary>
  951. </member>
  952. <member name="P:Delta.Utilities.Collections.TreeNodeCollection`1.Count">
  953. <summary>
  954. Count
  955. </summary>
  956. <returns>Int</returns>
  957. </member>
  958. <member name="P:Delta.Utilities.Collections.TreeNodeCollection`1.Owner">
  959. <summary>
  960. Owner
  961. </summary>
  962. <returns>Node</returns>
  963. </member>
  964. <member name="P:Delta.Utilities.Collections.TreeNodeCollection`1.Item(System.Int32)">
  965. <summary>
  966. Indexer
  967. </summary>
  968. <returns>Node</returns>
  969. </member>
  970. <member name="T:Delta.Utilities.Collections.TreeNodeCollectionTests">
  971. <summary>
  972. TreeNodeCollection tests
  973. </summary>
  974. </member>
  975. <member name="M:Delta.Utilities.Collections.TreeNodeCollectionTests.TestTreeNode">
  976. <summary>
  977. Test tree node
  978. </summary>
  979. </member>
  980. <member name="M:Delta.Utilities.Collections.TreeNodeCollectionTests.TestTreeNodeCollection">
  981. <summary>
  982. Test tree node collection
  983. </summary>
  984. </member>
  985. <member name="T:Delta.Utilities.Collections.CircularBuffer`1">
  986. <summary>
  987. CircularShortBuffer, used for recording/playback of sound samples.
  988. We can simply add new sample data and read existing sample data
  989. at the same time! The size of the circular buffer should fit
  990. the requirements (data should have been read when cycling around).
  991. There will be no warning if we overwrite data without reading.
  992. </summary>
  993. <typeparam name="T">Data type</typeparam>
  994. </member>
  995. <member name="F:Delta.Utilities.Collections.CircularBuffer`1.buffer">
  996. <summary>
  997. Buffer
  998. </summary>
  999. <typeparam name="T">T</typeparam>
  1000. </member>
  1001. <member name="F:Delta.Utilities.Collections.CircularBuffer`1.writePos">
  1002. <summary>
  1003. We only increase writePos and readPos, they will
  1004. obviously go way out of range of the buffer size,
  1005. we need ALWAYS to modulate it by the size of the buffer to access data!
  1006. We do this because only this way we can see how much data
  1007. was written and how much was read!
  1008. </summary>
  1009. <typeparam name="T">T</typeparam>
  1010. </member>
  1011. <member name="F:Delta.Utilities.Collections.CircularBuffer`1.readPos">
  1012. <summary>
  1013. Read pos
  1014. </summary>
  1015. <returns>0</returns>
  1016. <typeparam name="T">T</typeparam>
  1017. </member>
  1018. <member name="M:Delta.Utilities.Collections.CircularBuffer`1.#ctor(System.Int32)">
  1019. <summary>
  1020. Circular short buffer
  1021. </summary>
  1022. <param name="bufferSize">Buffer size</param>
  1023. </member>
  1024. <member name="M:Delta.Utilities.Collections.CircularBuffer`1.Flush">
  1025. <summary>
  1026. Flush is very simply, we just reset both writePos and readPos to 0.
  1027. </summary>
  1028. </member>
  1029. <member name="M:Delta.Utilities.Collections.CircularBuffer`1.Write(`0[])">
  1030. <summary>
  1031. Write array of new data to write into the circular buffer.
  1032. </summary>
  1033. <param name="newData">New data to write into the buffer</param>
  1034. </member>
  1035. <member name="M:Delta.Utilities.Collections.CircularBuffer`1.Read(`0[])">
  1036. <summary>
  1037. Read data into an array of the same type.
  1038. </summary>
  1039. <param name="readData">Data to read into</param>
  1040. </member>
  1041. <member name="P:Delta.Utilities.Collections.CircularBuffer`1.Length">
  1042. <summary>
  1043. Get how much bytes can be read, can even be more than buffer.Length
  1044. </summary>
  1045. <typeparam name="T">T</typeparam>
  1046. </member>
  1047. <member name="T:Delta.Utilities.Collections.CircularBufferTests">
  1048. <summary>
  1049. CircularBuffer tests helper, must be decleared outside of generic class.
  1050. </summary>
  1051. </member>
  1052. <member name="M:Delta.Utilities.Collections.CircularBufferTests.TestAddAndReadData">
  1053. <summary>
  1054. Test add and read data
  1055. </summary>
  1056. </member>
  1057. <member name="T:Delta.Utilities.Collections.UniqueChangeableList`1">
  1058. <summary>
  1059. Same as ChangeableList, which allows to add and remove elements
  1060. while enumerating, but this also checks if elements do already
  1061. exists. It will not add duplicates, duplicates are ignored!
  1062. </summary>
  1063. </member>
  1064. <member name="T:Delta.Utilities.Collections.ChangeableList`1">
  1065. <summary>
  1066. Changeable list is basically just a List, which allows
  1067. you to add and remove elements while enumerating.
  1068. When ALL enumerations are complete, all the remembered removed
  1069. and added elements will be applied (we can't do that while enumerating).
  1070. </summary>
  1071. <remarks>
  1072. You can use this list like a normal List and will never notice
  1073. any difference except when adding or removing entries while enumerating,
  1074. which will thrown an exception for normal Lists.
  1075. When the enumeration is complete and there are no other pending
  1076. enumerations, the ApplyAddedAndRemovedElements() function is called
  1077. and all added and removed elements are added and removed.
  1078. Another way would be to copy the whole list for the enumeration,
  1079. but this is much slower and usually we don't change the list that
  1080. often when enumerating (see slower approach here:)
  1081. http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncscol/html/csharp01212002.asp
  1082. </remarks>
  1083. <typeparam name="T">T</typeparam>
  1084. </member>
  1085. <member name="F:Delta.Utilities.Collections.ChangeableList`1.remElementsToBeAdded">
  1086. <summary>
  1087. Remembered elements to be added and removed when finished
  1088. enumerating. If we are not enumerating, adding and removing it
  1089. done directly (this lists are empty then).
  1090. Usually all these lists are empty, it will not happen very
  1091. often that we want to add or remove elements while enumerating.
  1092. </summary>
  1093. <typeparam name="T">T</typeparam>
  1094. </member>
  1095. <member name="F:Delta.Utilities.Collections.ChangeableList`1.remElementsToBeRemoved">
  1096. <summary>
  1097. Remembered elements to be added and removed when finished
  1098. enumerating. If we are not enumerating, adding and removing it
  1099. done directly (this lists are empty then).
  1100. Usually all these lists are empty, it will not happen very
  1101. often that we want to add or remove elements while enumerating.
  1102. </summary>
  1103. <typeparam name="T">T</typeparam>
  1104. </member>
  1105. <member name="F:Delta.Utilities.Collections.ChangeableLis…

Large files files are truncated, but you can click here to view the full file