a list of ids arranged in priority order More...

#include <vtkPriorityQueue.h>

Inheritance diagram for vtkPriorityQueue:

Collaboration diagram for vtkPriorityQueue:

Classes
class	Item

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPriorityQueue *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	Allocate (const vtkIdType sz, const vtkIdType ext=1000)

void	Insert (double priority, vtkIdType id)

vtkIdType	Pop (vtkIdType location=0)

vtkIdType	Peek (vtkIdType location=0)

double	DeleteId (vtkIdType id)

double	GetPriority (vtkIdType id)

vtkIdType	GetNumberOfItems ()

void	Reset ()


vtkIdType	Pop (vtkIdType location, double &priority)


vtkIdType	Peek (vtkIdType location, double &priority)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkPriorityQueue *	New ()

static int	IsTypeOf (const char *type)

static vtkPriorityQueue *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPriorityQueue ()

	~vtkPriorityQueue ()

Item *	Resize (const vtkIdType sz)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkIdTypeArray *	ItemLocation

Item *	Array

vtkIdType	Size

vtkIdType	MaxId

vtkIdType	Extend

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a list of ids arranged in priority order

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.

Warning: 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.

Definition at line 45 of file vtkPriorityQueue.h.

Member Typedef Documentation

typedef vtkObject vtkPriorityQueue::Superclass

Definition at line 61 of file vtkPriorityQueue.h.

Constructor & Destructor Documentation

vtkPriorityQueue::vtkPriorityQueue ( )

protected

vtkPriorityQueue::~vtkPriorityQueue ( )

protected

Member Function Documentation

static vtkPriorityQueue* vtkPriorityQueue::New ( )

static

Instantiate priority queue with default size and extension size of

static int vtkPriorityQueue::IsTypeOf ( const char * type )

static

virtual int vtkPriorityQueue::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkPriorityQueue* vtkPriorityQueue::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPriorityQueue::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkPriorityQueue* vtkPriorityQueue::NewInstance ( ) const

void vtkPriorityQueue::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkPriorityQueue::Allocate	(	const vtkIdType	sz,
		const vtkIdType	ext = `1000`
	)

Allocate initial space for priority queue.

void vtkPriorityQueue::Insert	(	double	priority,
		vtkIdType	id
	)

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

vtkIdType vtkPriorityQueue::Pop	(	vtkIdType	location,
		double &	priority
	)

Removes item at specified location from tree; then reorders and balances tree. The location == 0 is the root of the tree. If queue is exhausted, then a value < 0 is returned. (Note: the location is not the same as deleting an id; id is mapped to location.)

vtkIdType vtkPriorityQueue::Pop ( vtkIdType location = 0 )

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

vtkIdType vtkPriorityQueue::Peek	(	vtkIdType	location,
		double &	priority
	)

inline

Peek into the queue without actually removing anything. Returns the id and the priority.

Definition at line 153 of file vtkPriorityQueue.h.

vtkIdType vtkPriorityQueue::Peek ( vtkIdType location = 0 )

inline

Peek into the queue without actually removing anything. Returns the id.

Definition at line 166 of file vtkPriorityQueue.h.

double vtkPriorityQueue::DeleteId ( vtkIdType id )

inline

Delete entry in queue with specified id. Returns priority value associated with that id; or VTK_DOUBLE_MAX if not in queue.

Definition at line 128 of file vtkPriorityQueue.h.

double vtkPriorityQueue::GetPriority ( vtkIdType id )

inline

Get the priority of an entry in the queue with specified id. Returns priority value of that id or VTK_DOUBLE_MAX if not in queue.

Definition at line 141 of file vtkPriorityQueue.h.

vtkIdType vtkPriorityQueue::GetNumberOfItems ( )

inline

Return the number of items in this queue.

Definition at line 106 of file vtkPriorityQueue.h.

void vtkPriorityQueue::Reset ( )

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

Item* vtkPriorityQueue::Resize ( const vtkIdType sz )

protected

Member Data Documentation

vtkIdTypeArray* vtkPriorityQueue::ItemLocation

protected

Definition at line 118 of file vtkPriorityQueue.h.

Item* vtkPriorityQueue::Array

protected

Definition at line 119 of file vtkPriorityQueue.h.

vtkIdType vtkPriorityQueue::Size

protected

Definition at line 120 of file vtkPriorityQueue.h.

vtkIdType vtkPriorityQueue::MaxId

protected

Definition at line 121 of file vtkPriorityQueue.h.

vtkIdType vtkPriorityQueue::Extend

protected

Definition at line 122 of file vtkPriorityQueue.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkPriorityQueue.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation