Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
303 lines (285 sloc) 15.2 KB
<Type Name="IPriorityQueue&lt;TValue,TCont&gt;" FullName="Microsoft.VisualC.StlClr.IPriorityQueue&lt;TValue,TCont&gt;">
<TypeSignature Language="C#" Value="public interface IPriorityQueue&lt;TValue,TCont&gt; : ICloneable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IPriorityQueue`2&lt;TValue, TCont&gt; implements class System.ICloneable" />
<TypeSignature Language="DocId" Value="T:Microsoft.VisualC.StlClr.IPriorityQueue`2" />
<TypeSignature Language="VB.NET" Value="Public Interface IPriorityQueue(Of TValue, TCont)&#xA;Implements ICloneable" />
<TypeSignature Language="C++ CLI" Value="generic &lt;typename TValue, typename TCont&gt;&#xA;public interface class IPriorityQueue : ICloneable" />
<TypeSignature Language="F#" Value="type IPriorityQueue&lt;'Value, 'Cont&gt; = interface&#xA; interface ICloneable" />
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TValue" />
<TypeParameter Name="TCont" />
</TypeParameters>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TValue">The type of an element in the controlled sequence.</typeparam>
<typeparam name="TCont">The type of the underlying container.</typeparam>
<summary>Defines the interface for an STL/CLR <see href="https://docs.microsoft.com/cpp/dotnet/priority-queue-stl-clr">priority_queue</see> object.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="assign">
<MemberSignature Language="C#" Value="public void assign (Microsoft.VisualC.StlClr.IPriorityQueue&lt;TValue,TCont&gt; _Right);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void assign(class Microsoft.VisualC.StlClr.IPriorityQueue`2&lt;!TValue, !TCont&gt; _Right) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.assign(Microsoft.VisualC.StlClr.IPriorityQueue{`0,`1})" />
<MemberSignature Language="VB.NET" Value="Public Sub assign (_Right As IPriorityQueue(Of TValue, TCont))" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void assign(Microsoft::VisualC::StlClr::IPriorityQueue&lt;TValue, TCont&gt; ^ _Right);" />
<MemberSignature Language="F#" Value="abstract member assign : Microsoft.VisualC.StlClr.IPriorityQueue&lt;'Value, 'Cont&gt; -&gt; unit" Usage="iPriorityQueue.assign _Right" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="_Right" Type="Microsoft.VisualC.StlClr.IPriorityQueue&lt;TValue,TCont&gt;" />
</Parameters>
<Docs>
<param name="_Right">The container adapter to insert into the container.</param>
<summary>Replaces all elements of the container.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::assign (STL/CLR)](/cpp/dotnet/priority-queue-assign-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="empty">
<MemberSignature Language="C#" Value="public bool empty ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool empty() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.empty" />
<MemberSignature Language="VB.NET" Value="Public Function empty () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool empty();" />
<MemberSignature Language="F#" Value="abstract member empty : unit -&gt; bool" Usage="iPriorityQueue.empty " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether the container contains no elements.</summary>
<returns>
<see langword="true" /> if the container contains no elements; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::empty (STL/CLR)](/cpp/dotnet/priority-queue-empty-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="get_container">
<MemberSignature Language="C#" Value="public TCont get_container ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TCont get_container() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.get_container" />
<MemberSignature Language="VB.NET" Value="Public Function get_container () As TCont" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; TCont get_container();" />
<MemberSignature Language="F#" Value="abstract member get_container : unit -&gt; 'Cont" Usage="iPriorityQueue.get_container " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TCont</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Accesses the underlying container.</summary>
<returns>The underlying container. You can use it to bypass the restrictions that are imposed by the container wrapper.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority\_queue::get\_container (STL/CLR)](/cpp/dotnet/priority-queue-stl-clr#get_container).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="pop">
<MemberSignature Language="C#" Value="public void pop ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void pop() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.pop" />
<MemberSignature Language="VB.NET" Value="Public Sub pop ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void pop();" />
<MemberSignature Language="F#" Value="abstract member pop : unit -&gt; unit" Usage="iPriorityQueue.pop " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes the highest-priority element of the container.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::pop (STL/CLR)](/cpp/dotnet/priority-queue-pop-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="push">
<MemberSignature Language="C#" Value="public void push (TValue _Val);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void push(!TValue _Val) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.push(`0)" />
<MemberSignature Language="VB.NET" Value="Public Sub push (_Val As TValue)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void push(TValue _Val);" />
<MemberSignature Language="F#" Value="abstract member push : 'Value -&gt; unit" Usage="iPriorityQueue.push _Val" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="_Val" Type="TValue" />
</Parameters>
<Docs>
<param name="_Val">An element to insert into the controlled sequence. The controlled sequence is then reordered to maintain the heap discipline.</param>
<summary>Adds a new element to the container.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::push (STL/CLR)](/cpp/dotnet/priority-queue-push-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="size">
<MemberSignature Language="C#" Value="public int size ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 size() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.size" />
<MemberSignature Language="VB.NET" Value="Public Function size () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; int size();" />
<MemberSignature Language="F#" Value="abstract member size : unit -&gt; int" Usage="iPriorityQueue.size " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Counts the number of elements in the container.</summary>
<returns>The length of the controlled sequence.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::size (STL/CLR)](/cpp/dotnet/priority-queue-size-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="top">
<MemberSignature Language="C#" Value="public TValue top ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TValue top() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.top" />
<MemberSignature Language="VB.NET" Value="Public Function top () As TValue" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; TValue % top();" />
<MemberSignature Language="F#" Value="abstract member top : unit -&gt; " Usage="iPriorityQueue.top " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue@</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Accesses the highest-priority element of the container.</summary>
<returns>The top (highest-priority) element of the controlled sequence, which must be non-empty.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::top (STL/CLR)](/cpp/dotnet/priority-queue-top-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="top_item">
<MemberSignature Language="C#" Value="public TValue top_item { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TValue top_item" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualC.StlClr.IPriorityQueue`2.top_item" />
<MemberSignature Language="VB.NET" Value="Public Property top_item As TValue" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property TValue top_item { TValue get(); void set(TValue value); };" />
<MemberSignature Language="F#" Value="member this.top_item : 'Value with get, set" Usage="Microsoft.VisualC.StlClr.IPriorityQueue&lt;'Value, 'Cont&gt;.top_item" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<Docs>
<summary>Accesses the highest-priority element of the container.</summary>
<value>The top (highest-priority) element of the controlled sequence, which must be non-empty.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::top_item (STL/CLR)](/cpp/dotnet/priority-queue-top-item-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="value_comp">
<MemberSignature Language="C#" Value="public Microsoft.VisualC.StlClr.BinaryDelegate&lt;TValue,TValue,bool&gt; value_comp ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.VisualC.StlClr.BinaryDelegate`3&lt;!TValue, !TValue, bool&gt; value_comp() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.value_comp" />
<MemberSignature Language="VB.NET" Value="Public Function value_comp () As BinaryDelegate(Of TValue, TValue, Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::VisualC::StlClr::BinaryDelegate&lt;TValue, TValue, bool&gt; ^ value_comp();" />
<MemberSignature Language="F#" Value="abstract member value_comp : unit -&gt; Microsoft.VisualC.StlClr.BinaryDelegate&lt;'Value, 'Value, bool&gt;" Usage="iPriorityQueue.value_comp " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.VisualC.StlClr.BinaryDelegate&lt;TValue,TValue,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copies the ordering delegate for two elements.</summary>
<returns>The ordering delegate used to order the controlled sequence. You use it to compare two values.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information, see [priority_queue::value_comp (STL/CLR)](/cpp/dotnet/priority-queue-value-comp-stl-clr).
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.