ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkPriorityQueue Class Reference

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

Inheritance diagram for Kitware.VTK.vtkPriorityQueue:
[legend]
Collaboration diagram for Kitware.VTK.vtkPriorityQueue:
[legend]

List of all members.

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 (int sz, int ext)
 Allocate initial space for priority queue.
double DeleteId (int id)
 Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
int GetNumberOfItems ()
 Return the number of items in this queue.
double GetPriority (int id)
 Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
void Insert (double priority, int 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.
int Peek (int location, ref double priority)
 Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
int Peek (int location)
 Empty the queue but without releasing memory. This avoids the overhead of memory allocation/deletion.
int Pop (int location, ref double priority)
 Insert id with priority specified. The id is generally an index like a point id or cell id.
int Pop (int 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, int sz, int ext)
static internal double vtkPriorityQueue_DeleteId_02 (HandleRef pThis, int id)
static internal int vtkPriorityQueue_GetNumberOfItems_03 (HandleRef pThis)
static internal double vtkPriorityQueue_GetPriority_04 (HandleRef pThis, int id)
static internal void vtkPriorityQueue_Insert_05 (HandleRef pThis, double priority, int 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 int vtkPriorityQueue_Peek_10 (HandleRef pThis, int location, ref double priority)
static internal int vtkPriorityQueue_Peek_11 (HandleRef pThis, int location)
static internal int vtkPriorityQueue_Pop_12 (HandleRef pThis, int location, ref double priority)
static internal int vtkPriorityQueue_Pop_13 (HandleRef pThis, int 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.

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


Member Function Documentation

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

Allocate initial space for priority queue.

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.

Return the number of items in this queue.

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

void Kitware.VTK.vtkPriorityQueue.Insert ( double  priority,
int  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.

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

Reimplemented from Kitware.VTK.vtkObject.

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

Reimplemented from Kitware.VTK.vtkObject.

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

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

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

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

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

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

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

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

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

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,
int  sz,
int  ext 
) [private]
static internal double Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_DeleteId_02 ( HandleRef  pThis,
int  id 
) [private]
static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_GetNumberOfItems_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_GetPriority_04 ( HandleRef  pThis,
int  id 
) [private]
static internal void Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Insert_05 ( HandleRef  pThis,
double  priority,
int  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 int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Peek_10 ( HandleRef  pThis,
int  location,
ref double  priority 
) [private]
static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Peek_11 ( HandleRef  pThis,
int  location 
) [private]
static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Pop_12 ( HandleRef  pThis,
int  location,
ref double  priority 
) [private]
static internal int Kitware.VTK.vtkPriorityQueue.vtkPriorityQueue_Pop_13 ( HandleRef  pThis,
int  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]

Member Data Documentation

new readonly string Kitware.VTK.vtkPriorityQueue.MRClassNameKey = "16vtkPriorityQueue" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkPriorityQueue.MRFullTypeName = "Kitware.VTK.vtkPriorityQueue"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


The documentation for this class was generated from the following file: