Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

common/vtkPriorityQueue.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkPriorityQueue.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00065 #ifndef __vtkPriorityQueue_h
00066 #define __vtkPriorityQueue_h
00067 
00068 #include "vtkObject.h"
00069 #include "vtkIntArray.h"
00070 
00071 //BTX
00072 typedef struct _vtkPriorityItem
00073   {
00074   float priority;
00075   int id;
00076   } vtkPriorityItem;
00077 //ETX
00078 
00079 class VTK_EXPORT vtkPriorityQueue : public vtkObject
00080 {
00081 public:
00084   static vtkPriorityQueue *New();
00085 
00086   vtkTypeMacro(vtkPriorityQueue,vtkObject);
00087   void PrintSelf(ostream& os, vtkIndent indent);
00088 
00090   void Allocate(const int sz, const int ext=1000);
00091 
00094   void Insert(float priority, int id);
00095 
00100   int Pop(float &priority, int location=0);
00101   
00104   int Pop(int location=0);
00105   
00108   int Peek(float &priority, int location=0);
00109   
00112   int Peek(int location=0);
00113   
00116   float DeleteId(int id);
00117 
00120   float GetPriority(int id);
00121 
00123   int GetNumberOfItems() {return this->MaxId+1;};
00124 
00127   void Reset();
00128 
00129 protected:
00130   vtkPriorityQueue();
00131   ~vtkPriorityQueue();
00132   vtkPriorityQueue(const vtkPriorityQueue&) {};
00133   void operator=(const vtkPriorityQueue&) {};
00134   
00135   vtkPriorityItem *Resize(const int sz);
00136 
00137   vtkIntArray *ItemLocation;
00138   vtkPriorityItem *Array;
00139   int Size;
00140   int MaxId;
00141   int Extend;
00142 };
00143 
00144 inline float vtkPriorityQueue::DeleteId(int id)
00145 {
00146   float priority=VTK_LARGE_FLOAT;
00147   int loc;
00148 
00149   if ( id <= this->ItemLocation->GetMaxId() &&  
00150   (loc=this->ItemLocation->GetValue(id)) != -1 )
00151     {
00152     this->Pop(priority,loc);
00153     }
00154   return priority;
00155 }
00156 
00157 inline float vtkPriorityQueue::GetPriority(int id)
00158 {
00159   int loc;
00160 
00161   if ( id <= this->ItemLocation->GetMaxId() &&  
00162   (loc=this->ItemLocation->GetValue(id)) != -1 )
00163     {
00164     return this->Array[loc].priority;
00165     }
00166   return VTK_LARGE_FLOAT;
00167 }
00168 
00169 inline int vtkPriorityQueue::Peek(float &priority, int location)
00170 {
00171   if ( this->MaxId < 0 )
00172     {
00173     return -1;
00174     }
00175   else
00176     {
00177     priority = this->Array[location].priority;
00178     return this->Array[location].id;
00179     }
00180 }
00181 
00182 inline int vtkPriorityQueue::Peek(int location)
00183 {
00184   if ( this->MaxId < 0 )
00185     {
00186     return -1;
00187     }
00188   else
00189     {
00190     return this->Array[location].id;
00191     }
00192 }
00193 
00194 #endif

Generated on Wed Nov 21 12:26:53 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001