diff options
author | Gabriel Burt <gabriel.burt@gmail.com> | 2010-03-20 14:56:51 -0700 |
---|---|---|
committer | Gabriel Burt <gabriel.burt@gmail.com> | 2010-03-20 17:16:47 -0700 |
commit | 016f78f76bb257739913e4c9edbcc0540d665886 (patch) | |
tree | f55afd4f7a57f31c5c79ee50acbfb9fed439d530 /docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml | |
parent | 215a95fb78deb6162e0d4d350a1ecd72ff867fc6 (diff) |
Update API docs
Diffstat (limited to 'docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml')
-rw-r--r-- | docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml | 378 |
1 files changed, 299 insertions, 79 deletions
diff --git a/docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml b/docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml index 4ea517540..c122b1746 100644 --- a/docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml +++ b/docs/Hyena/en/Hyena.Collections/IntervalHeap`1.xml @@ -1,13 +1,14 @@ <Type Name="IntervalHeap<T>" FullName="Hyena.Collections.IntervalHeap<T>"> - <TypeSignature Language="C#" Value="public class IntervalHeap<T> : System.Collections.Generic.ICollection<T>, System.Collections.ICollection" /> + <TypeSignature Language="C#" Value="public class IntervalHeap<T> : System.Collections.Generic.ICollection<T>, System.Collections.Generic.IEnumerable<T>, System.Collections.ICollection" /> <AssemblyInfo> <AssemblyName>Hyena</AssemblyName> <AssemblyVersion>0.90.1.25402</AssemblyVersion> <AssemblyVersion>1.3.1.0</AssemblyVersion> <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> </AssemblyInfo> <TypeParameters> - <TypeParameter>T</TypeParameter> + <TypeParameter Name="T" /> </TypeParameters> <Base> <BaseTypeName>System.Object</BaseTypeName> @@ -17,6 +18,9 @@ <InterfaceName>System.Collections.Generic.ICollection<T></InterfaceName> </Interface> <Interface> + <InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName> + </Interface> + <Interface> <InterfaceName>System.Collections.ICollection</InterfaceName> </Interface> </Interfaces> @@ -26,126 +30,342 @@ <remarks>To be added.</remarks> </Docs> <Members> - - - - - - - - - - - - - - - - - <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public IntervalHeap ();" /> <MemberType>Constructor</MemberType> <Parameters /> - <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Add"> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Add"> <MemberSignature Language="C#" Value="public virtual void Add (T item);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> - <Parameters><Parameter Name="item" Type="T" /></Parameters> - <Docs><param name="item">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Clear"> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="item" Type="T" /> + </Parameters> + <Docs> + <param name="item">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Clear"> <MemberSignature Language="C#" Value="public virtual void Clear ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Contains"> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Contains"> <MemberSignature Language="C#" Value="public virtual bool Contains (T item);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Boolean</ReturnType></ReturnValue> - <Parameters><Parameter Name="item" Type="T" /></Parameters> - <Docs><param name="item">To be added.</param><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="CopyTo"> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="item" Type="T" /> + </Parameters> + <Docs> + <param name="item">To be added.</param> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="CopyTo"> <MemberSignature Language="C#" Value="public virtual void CopyTo (T[] array, int index);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> - <Parameters><Parameter Name="array" Type="T[]" /><Parameter Name="index" Type="System.Int32" /></Parameters> - <Docs><param name="array">To be added.</param><param name="index">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Count"> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="array" Type="T[]" /> + <Parameter Name="index" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="array">To be added.</param> + <param name="index">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Count"> <MemberSignature Language="C#" Value="public virtual int Count { get; }" /> <MemberType>Property</MemberType> - <ReturnValue><ReturnType>System.Int32</ReturnType></ReturnValue> - <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="GetEnumerator"> + <ReturnValue> + <ReturnType>System.Int32</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="GetEnumerator"> <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IEnumerator<T> GetEnumerator ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Collections.Generic.IEnumerator<T></ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>System.Collections.Generic.IEnumerator<T></ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="IsReadOnly"> + <Docs> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="IsReadOnly"> <MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" /> <MemberType>Property</MemberType> - <ReturnValue><ReturnType>System.Boolean</ReturnType></ReturnValue> - <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="IsSynchronized"> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="IsSynchronized"> <MemberSignature Language="C#" Value="public virtual bool IsSynchronized { get; }" /> <MemberType>Property</MemberType> - <ReturnValue><ReturnType>System.Boolean</ReturnType></ReturnValue> - <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Peek"> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Peek"> <MemberSignature Language="C#" Value="public virtual T Peek ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>T</ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>T</ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Pop"> + <Docs> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Pop"> <MemberSignature Language="C#" Value="public virtual T Pop ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>T</ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>T</ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Push"> + <Docs> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Push"> <MemberSignature Language="C#" Value="public virtual void Push (T item, int priority);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> - <Parameters><Parameter Name="item" Type="T" /><Parameter Name="priority" Type="System.Int32" /></Parameters> - <Docs><param name="item">To be added.</param><param name="priority">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Remove"> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="item" Type="T" /> + <Parameter Name="priority" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="item">To be added.</param> + <param name="priority">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Remove"> <MemberSignature Language="C#" Value="public virtual bool Remove (T item);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Boolean</ReturnType></ReturnValue> - <Parameters><Parameter Name="item" Type="T" /></Parameters> - <Docs><param name="item">To be added.</param><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="Synchronized"> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="item" Type="T" /> + </Parameters> + <Docs> + <param name="item">To be added.</param> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="Synchronized"> <MemberSignature Language="C#" Value="public static Hyena.Collections.IntervalHeap<T> Synchronized (Hyena.Collections.IntervalHeap<T> heap);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>Hyena.Collections.IntervalHeap<T></ReturnType></ReturnValue> - <Parameters><Parameter Name="heap" Type="Hyena.Collections.IntervalHeap<T>" /></Parameters> - <Docs><param name="heap">To be added.</param><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="SyncRoot"> + <ReturnValue> + <ReturnType>Hyena.Collections.IntervalHeap<T></ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="heap" Type="Hyena.Collections.IntervalHeap<T>" /> + </Parameters> + <Docs> + <param name="heap">To be added.</param> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="SyncRoot"> <MemberSignature Language="C#" Value="public virtual object SyncRoot { get; }" /> <MemberType>Property</MemberType> - <ReturnValue><ReturnType>System.Object</ReturnType></ReturnValue> - <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="System.Collections.ICollection.CopyTo"> + <ReturnValue> + <ReturnType>System.Object</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="System.Collections.ICollection.CopyTo"> <MemberSignature Language="C#" Value="void ICollection.CopyTo (Array array, int index);" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> - <Parameters><Parameter Name="array" Type="System.Array" /><Parameter Name="index" Type="System.Int32" /></Parameters> - <Docs><param name="array">To be added.</param><param name="index">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="System.Collections.IEnumerable.GetEnumerator"> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="array" Type="System.Array" /> + <Parameter Name="index" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="array">To be added.</param> + <param name="index">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> <MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Collections.IEnumerator</ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>System.Collections.IEnumerator</ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><returns>To be added.</returns><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member><Member MemberName="TrimExcess"> + <Docs> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> + <Member MemberName="TrimExcess"> <MemberSignature Language="C#" Value="public virtual void TrimExcess ();" /> <MemberType>Method</MemberType> - <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> <Parameters /> - <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> - <AssemblyInfo><AssemblyVersion>1.3.1.0</AssemblyVersion><AssemblyVersion>1.4.0.0</AssemblyVersion></AssemblyInfo></Member> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <AssemblyInfo> + <AssemblyVersion>1.3.1.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + </AssemblyInfo> + </Member> </Members> </Type> |