Class PriorityQueue<T>

A collection that provides efficient extraction of the minimum element.

Inheritance

Object

PriorityQueue<T>

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Microsoft.ML.Probabilistic.Collections

Assembly: Microsoft.ML.Probabilistic.dll

Syntax

public class PriorityQueue<T>

Type Parameters

Name	Description
T

Constructors

PriorityQueue()

Declaration

public PriorityQueue()

PriorityQueue(IComparer<T>)

Declaration

public PriorityQueue(IComparer<T> comparer)

Parameters

Type	Name	Description
IComparer<T>	comparer

PriorityQueue(IEnumerable<T>)

Create a priority queue initialized with the contents of list.

Declaration

public PriorityQueue(IEnumerable<T> list)

Parameters

Type	Name	Description
IEnumerable<T>	list

PriorityQueue(IEnumerable<T>, Action<T, Int32>)

Create a priority queue initialized with the contents of list.

Declaration

public PriorityQueue(IEnumerable<T> list, Action<T, int> moved)

Parameters

Type	Name	Description
IEnumerable<T>	list
Action<T, Int32>	moved

PriorityQueue(IEnumerable<T>, IComparer<T>)

Create a priority queue initialized with the contents of list.

Declaration

public PriorityQueue(IEnumerable<T> list, IComparer<T> comparer)

Parameters

Type	Name	Description
IEnumerable<T>	list
IComparer<T>	comparer

PriorityQueue(IEnumerable<T>, IComparer<T>, Action<T, Int32>)

Create a priority queue initialized with the contents of list.

Declaration

public PriorityQueue(IEnumerable<T> list, IComparer<T> comparer, Action<T, int> moved)

Parameters

Type	Name	Description
IEnumerable<T>	list
IComparer<T>	comparer
Action<T, Int32>	moved

PriorityQueue(Int32)

Create a priority queue filled with count items equal to default(T).

Declaration

public PriorityQueue(int count)

Parameters

Type	Name	Description
Int32	count

PriorityQueue(Int32, IComparer<T>)

Create a priority queue filled with count items equal to default(T).

Declaration

public PriorityQueue(int count, IComparer<T> comparer)

Parameters

Type	Name	Description
Int32	count
IComparer<T>	comparer

Fields

Comparer

Declaration

public IComparer<T> Comparer

Field Value

Type	Description
IComparer<T>

Items

Declaration

public List<T> Items

Field Value

Type	Description
List<T>

Properties

Count

Declaration

public int Count { get; }

Property Value

Type	Description
Int32

Item[Int32]

Declaration

public T this[int index] { get; set; }

Parameters

Type	Name	Description
Int32	index

Property Value

Type	Description
T

Methods

Add(T)

Add a new item to the queue.

Declaration

public void Add(T item)

Parameters

Type	Name	Description
T	item

AddRange(IEnumerable<T>)

Add several new items to the queue.

Declaration

public void AddRange(IEnumerable<T> items)

Parameters

Type	Name	Description
IEnumerable<T>	items

Changed(Int32)

Reposition node i to restore the heap property.

Declaration

public void Changed(int i)

Parameters

Type	Name	Description
Int32	i

Clear()

Declaration

public void Clear()

Clone()

Declaration

public PriorityQueue<T> Clone()

Returns

Type	Description
PriorityQueue<T>

Contains(T)

Declaration

public bool Contains(T item)

Parameters

Type	Name	Description
T	item

Returns

Type	Description
Boolean

ExtractMinimum()

Declaration

public T ExtractMinimum()

Returns

Type	Description
T

IndexOf(T)

Declaration

public int IndexOf(T item)

Parameters

Type	Name	Description
T	item

Returns

Type	Description
Int32

Left(Int32)

Declaration

protected int Left(int index)

Parameters

Type	Name	Description
Int32	index

Returns

Type	Description
Int32

LessThan(Int32, Int32)

Declaration

public bool LessThan(int i, int j)

Parameters

Type	Name	Description
Int32	i
Int32	j

Returns

Type	Description
Boolean

Parent(Int32)

Declaration

protected int Parent(int index)

Parameters

Type	Name	Description
Int32	index

Returns

Type	Description
Int32

RemoveAt(Int32)

Remove the item at Items[i]

Declaration

public void RemoveAt(int i)

Parameters

Type	Name	Description
Int32	i	Position in the Items array

Right(Int32)

Declaration

protected int Right(int index)

Parameters

Type	Name	Description
Int32	index

Returns

Type	Description
Int32

SiftAll()

Rearrange all items to satisfy the heap property.

Declaration

public void SiftAll()

SiftDown(Int32)

Move Items[i] downward until it is less than or equal to its children.

Declaration

public void SiftDown(int i)

Parameters

Type	Name	Description
Int32	i

SiftUp(Int32)

Move Items[i] upward until it is greater than or equal to its parent.

Declaration

public void SiftUp(int i)

Parameters

Type	Name	Description
Int32	i	An index into Items.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Events

Moved

Raised when an item has changed position or been removed (-1).

Declaration

public event Action<T, int> Moved

Event Type

Type	Description
Action<T, Int32>