vtkPriorityQueue - an list of ids arranged in priority order More...

Inheritance diagram for Kitware.VTK.vtkPriorityQueue:

Collaboration diagram for Kitware.VTK.vtkPriorityQueue:

Public Member Functions
	vtkPriorityQueue (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkPriorityQueue ()
	Instantiate priority queue with default size and extension size of 1000.
void	Allocate (long sz, long ext)
	Allocate initial space for priority queue.
double	DeleteId (long id)
	Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
long	GetNumberOfItems ()
	Return the number of items in this queue.
double	GetPriority (long id)
	Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
void	Insert (double priority, long id)
	Insert id with priority specified. The id is generally an index like a point id or cell id.
override int	IsA (string type)
	Instantiate priority queue with default size and extension size of 1000.
new vtkPriorityQueue	NewInstance ()
	Instantiate priority queue with default size and extension size of 1000.
long	Peek (long location, ref double priority)
	Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
long	Peek (long location)
	Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
long	Pop (long location, ref double priority)
	Insert id with priority specified. The id is generally an index like a point id or cell id.
long	Pop (long location)
	Same as above but simplified for easier wrapping into interpreted languages.
void	Reset ()
	Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
Static Public Member Functions
static new vtkPriorityQueue	New ()
	Instantiate priority queue with default size and extension size of 1000.
static new int	IsTypeOf (string type)
	Instantiate priority queue with default size and extension size of 1000.
static new vtkPriorityQueue	SafeDownCast (vtkObjectBase o)
	Instantiate priority queue with default size and extension size of 1000.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkPriorityQueue"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "16vtkPriorityQueue"
	Automatically generated type registration mechanics.
Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Private Member Functions
static internal IntPtr	vtkPriorityQueue_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkPriorityQueue_Allocate_01 (HandleRef pThis, long sz, long ext)
static internal double	vtkPriorityQueue_DeleteId_02 (HandleRef pThis, long id)
static internal long	vtkPriorityQueue_GetNumberOfItems_03 (HandleRef pThis)
static internal double	vtkPriorityQueue_GetPriority_04 (HandleRef pThis, long id)
static internal void	vtkPriorityQueue_Insert_05 (HandleRef pThis, double priority, long id)
static internal int	vtkPriorityQueue_IsA_06 (HandleRef pThis, string type)
static internal int	vtkPriorityQueue_IsTypeOf_07 (string type)
static internal IntPtr	vtkPriorityQueue_NewInstance_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal long	vtkPriorityQueue_Peek_10 (HandleRef pThis, long location, ref double priority)
static internal long	vtkPriorityQueue_Peek_11 (HandleRef pThis, long location)
static internal long	vtkPriorityQueue_Pop_12 (HandleRef pThis, long location, ref double priority)
static internal long	vtkPriorityQueue_Pop_13 (HandleRef pThis, long location)
static internal void	vtkPriorityQueue_Reset_14 (HandleRef pThis)
static internal IntPtr	vtkPriorityQueue_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
Static Private Member Functions
static	vtkPriorityQueue ()
	Automatically generated type registration mechanics.

Detailed Description

vtkPriorityQueue - an list of ids arranged in priority order

Description vtkPriorityQueue is a general object for creating and manipulating lists of object ids (e.g., point or cell ids). Object ids are sorted according to a user-specified priority, where entries at the top of the queue have the smallest values.

This implementation provides a feature beyond the usual ability to insert and retrieve (or pop) values from the queue. It is also possible to pop any item in the queue given its id number. This allows you to delete entries in the queue which can useful for reinserting an item into the queue.

Caveats This implementation is a variation of the priority queue described in "Data Structures & Algorithms" by Aho, Hopcroft, Ullman. It creates a balanced, partially ordered binary tree implemented as an ordered array. This avoids the overhead associated with parent/child pointers, and frequent memory allocation and deallocation.

Constructor & Destructor Documentation

static Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue ( )

Instantiate priority queue with default size and extension size of 1000.

Member Function Documentation

void Kitware.VTK.vtkPriorityQueue.Allocate	(	long	sz,
		long	ext
	)

Allocate initial space for priority queue.

double Kitware.VTK.vtkPriorityQueue.DeleteId ( long id )

Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.

override void Kitware.VTK.vtkPriorityQueue.Dispose ( bool disposing ) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

long Kitware.VTK.vtkPriorityQueue.GetNumberOfItems ( )

Return the number of items in this queue.

double Kitware.VTK.vtkPriorityQueue.GetPriority ( long id )

Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.

void Kitware.VTK.vtkPriorityQueue.Insert	(	double	priority,
		long	id
	)

Insert id with priority specified. The id is generally an index like a point id or cell id.

override int Kitware.VTK.vtkPriorityQueue.IsA ( string type ) [virtual]

Instantiate priority queue with default size and extension size of 1000.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkPriorityQueue.IsTypeOf ( string type ) [static]

Instantiate priority queue with default size and extension size of 1000.

Reimplemented from Kitware.VTK.vtkObject.

static new vtkPriorityQueue Kitware.VTK.vtkPriorityQueue.New ( ) [static]

Instantiate priority queue with default size and extension size of 1000.

Reimplemented from Kitware.VTK.vtkObject.

new vtkPriorityQueue Kitware.VTK.vtkPriorityQueue.NewInstance ( )

Instantiate priority queue with default size and extension size of 1000.

Reimplemented from Kitware.VTK.vtkObject.

long Kitware.VTK.vtkPriorityQueue.Peek	(	long	location,
		ref double	priority
	)

Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.

long Kitware.VTK.vtkPriorityQueue.Peek ( long location )

Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.

long Kitware.VTK.vtkPriorityQueue.Pop	(	long	location,
		ref double	priority
	)

Insert id with priority specified. The id is generally an index like a point id or cell id.

long Kitware.VTK.vtkPriorityQueue.Pop ( long location )

Same as above but simplified for easier wrapping into interpreted languages.

void Kitware.VTK.vtkPriorityQueue.Reset ( )

Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.

static new vtkPriorityQueue Kitware.VTK.vtkPriorityQueue.SafeDownCast ( vtkObjectBase o ) [static]

Instantiate priority queue with default size and extension size of 1000.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

static internal void Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Allocate_01	(	HandleRef	pThis,
		long	sz,
		long	ext
	)		`[private]`

static internal double Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_DeleteId_02	(	HandleRef	pThis,
		long	id
	)		`[private]`

static internal long Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_GetNumberOfItems_03 ( HandleRef pThis ) [private]

static internal double Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_GetPriority_04	(	HandleRef	pThis,
		long	id
	)		`[private]`

static internal void Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Insert_05	(	HandleRef	pThis,
		double	priority,
		long	id
	)		`[private]`

static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_IsA_06	(	HandleRef	pThis,
		string	type
	)		`[private]`

static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_IsTypeOf_07 ( string type ) [private]

static internal IntPtr Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_NewInstance_09	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal long Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Peek_10	(	HandleRef	pThis,
		long	location,
		ref double	priority
	)		`[private]`

static internal long Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Peek_11	(	HandleRef	pThis,
		long	location
	)		`[private]`

static internal long Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Pop_12	(	HandleRef	pThis,
		long	location,
		ref double	priority
	)		`[private]`

static internal long Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Pop_13	(	HandleRef	pThis,
		long	location
	)		`[private]`

static internal void Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Reset_14 ( HandleRef pThis ) [private]

static internal IntPtr Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_SafeDownCast_15	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`