Changeset - r710:f1fe0ddad6f7
« 709:0747f3
711:28cfac »
gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Move the heaps to a separate group (#299)
0 6 0
default
6 files changed with 40 insertions and 19 deletions:
doc/groups.dox
30
9
lemon/bin_heap.h
2
2
lemon/bucket_heap.h
3
3
lemon/concepts/heap.h
1
1
lemon/fib_heap.h
2
2
lemon/radix_heap.h
2
2
↑ Collapse diff ↑
doc/groups.dox
Ignore white space 6 line context
... ... 
@@ -225,16 +225,8 @@
225 225 
\c Dijkstra algorithm.
226 226 
*/
227 227 

			




	228
	228
	
		
/**


			




	229
	
	
		
@defgroup matrices Matrices


			




	230
	
	
		
@ingroup datas


			




	231
	
	
		
\brief Two dimensional data storages implemented in LEMON.


			




	232
	
	
		

			




	233
	
	
		
This group contains two dimensional data storages implemented in LEMON.


			




	234
	
	
		
*/


			




	235
	
	
		

			




	236
	
	
		
/**


			




	237
	229
	
		
@defgroup paths Path Structures


			




	238
	230
	
		
@ingroup datas


			




	239
	231
	
		
\brief %Path structures implemented in LEMON.


			




	240
	232
	
		

			




	...
	...
	
		
@@ -245,9 +237,38 @@


			




	245
	237
	
		
assignment operators and copy constructors. This makes it easy and


			




	246
	238
	
		
efficient to have e.g. the Dijkstra algorithm to store its result in


			




	247
	239
	
		
any kind of path structure.


			




	248
	240
	
		

			




	249
	
	
		
\sa lemon::concepts::Path


			




	
	241
	
		
\sa \ref concepts::Path "Path concept"


			




	
	242
	
		
*/


			




	
	243
	
		

			




	
	244
	
		
/**


			




	
	245
	
		
@defgroup heaps Heap Structures


			




	
	246
	
		
@ingroup datas


			




	
	247
	
		
\brief %Heap structures implemented in LEMON.


			




	
	248
	
		

			




	
	249
	
		
This group contains the heap structures implemented in LEMON.


			




	
	250
	
		

			




	
	251
	
		
LEMON provides several heap classes. They are efficient implementations


			




	
	252
	
		
of the abstract data type \e priority \e queue. They store items with


			




	
	253
	
		
specified values called \e priorities in such a way that finding and


			




	
	254
	
		
removing the item with minimum priority are efficient.


			




	
	255
	
		
The basic operations are adding and erasing items, changing the priority


			




	
	256
	
		
of an item, etc.


			




	
	257
	
		

			




	
	258
	
		
Heaps are crucial in several algorithms, such as Dijkstra and Prim.


			




	
	259
	
		
The heap implementations have the same interface, thus any of them can be


			




	
	260
	
		
used easily in such algorithms.


			




	
	261
	
		

			




	
	262
	
		
\sa \ref concepts::Heap "Heap concept"


			




	
	263
	
		
*/


			




	
	264
	
		

			




	
	265
	
		
/**


			




	
	266
	
		
@defgroup matrices Matrices


			




	
	267
	
		
@ingroup datas


			




	
	268
	
		
\brief Two dimensional data storages implemented in LEMON.


			




	
	269
	
		

			




	
	270
	
		
This group contains two dimensional data storages implemented in LEMON.


			




	250
	271
	
		
*/


			




	251
	272
	
		

			




	252
	273
	
		
/**


			




	253
	274
	
		
@defgroup auxdat Auxiliary Data Structures

			




        

    

    

    

        

            

                

                    lemon/bin_heap.h
                

                

                  
                  
                  
                  Ignore white space
                  6 line context
                

                
                  
                
            

        

        

            

            



	...
	...
	
		
@@ -18,9 +18,9 @@


			




	18
	18
	
		

			




	19
	19
	
		
#ifndef LEMON_BIN_HEAP_H


			




	20
	20
	
		
#define LEMON_BIN_HEAP_H


			




	21
	21
	
		

			




	22
	
	
		
///\ingroup auxdat


			




	
	22
	
		
///\ingroup heaps


			




	23
	23
	
		
///\file


			




	24
	24
	
		
///\brief Binary heap implementation.


			




	25
	25
	
		

			




	26
	26
	
		
#include <vector>


			




	...
	...
	
		
@@ -28,9 +28,9 @@


			




	28
	28
	
		
#include <functional>


			




	29
	29
	
		

			




	30
	30
	
		
namespace lemon {


			




	31
	31
	
		

			




	32
	
	
		
  /// \ingroup auxdat


			




	
	32
	
		
  /// \ingroup heaps


			




	33
	33
	
		
  ///


			




	34
	34
	
		
  /// \brief Binary heap data structure.


			




	35
	35
	
		
  ///


			




	36
	36
	
		
  /// This class implements the \e binary \e heap data structure.

			




        

    

    

    

        

            

                

                    lemon/bucket_heap.h
                

                

                  
                  
                  
                  Ignore white space
                  6 line context
                

                
                  
                
            

        

        

            

            



	...
	...
	
		
@@ -18,9 +18,9 @@


			




	18
	18
	
		

			




	19
	19
	
		
#ifndef LEMON_BUCKET_HEAP_H


			




	20
	20
	
		
#define LEMON_BUCKET_HEAP_H


			




	21
	21
	
		

			




	22
	
	
		
///\ingroup auxdat


			




	
	22
	
		
///\ingroup heaps


			




	23
	23
	
		
///\file


			




	24
	24
	
		
///\brief Bucket heap implementation.


			




	25
	25
	
		

			




	26
	26
	
		
#include <vector>


			




	...
	...
	
		
@@ -52,9 +52,9 @@


			




	52
	52
	
		
    };


			




	53
	53
	
		

			




	54
	54
	
		
  }


			




	55
	55
	
		

			




	56
	
	
		
  /// \ingroup auxdat


			




	
	56
	
		
  /// \ingroup heaps


			




	57
	57
	
		
  ///


			




	58
	58
	
		
  /// \brief Bucket heap data structure.


			




	59
	59
	
		
  ///


			




	60
	60
	
		
  /// This class implements the \e bucket \e heap data structure.


			




	...
	...
	
		
@@ -370,9 +370,9 @@


			




	370
	370
	
		
    mutable int _minimum;


			




	371
	371
	
		

			




	372
	372
	
		
  }; // class BucketHeap


			




	373
	373
	
		

			




	374
	
	
		
  /// \ingroup auxdat


			




	
	374
	
		
  /// \ingroup heaps


			




	375
	375
	
		
  ///


			




	376
	376
	
		
  /// \brief Simplified bucket heap data structure.


			




	377
	377
	
		
  ///


			




	378
	378
	
		
  /// This class implements a simplified \e bucket \e heap data

			




        

    

    

    

        

            

                

                    lemon/concepts/heap.h
                

                

                  
                  
                  
                  Ignore white space
                  8 line context
                

                
                  
                
            

        

        

            

            



	...
	...
	
		
@@ -35,9 +35,9 @@


			




	35
	35
	
		

			




	36
	36
	
		
    /// \brief The heap concept.


			




	37
	37
	
		
    ///


			




	38
	38
	
		
    /// This concept class describes the main interface of heaps.


			




	39
	
	
		
    /// The various heap structures are efficient


			




	
	39
	
		
    /// The various \ref heaps "heap structures" are efficient


			




	40
	40
	
		
    /// implementations of the abstract data type \e priority \e queue.


			




	41
	41
	
		
    /// They store items with specified values called \e priorities


			




	42
	42
	
		
    /// in such a way that finding and removing the item with minimum


			




	43
	43
	
		
    /// priority are efficient. The basic operations are adding and

			




        

    

    

    

        

            

                

                    lemon/fib_heap.h
                

                

                  
                  
                  
                  Ignore white space
                  6 line context
                

                
                  
                
            

        

        

            

            



	...
	...
	
		
@@ -19,9 +19,9 @@


			




	19
	19
	
		
#ifndef LEMON_FIB_HEAP_H


			




	20
	20
	
		
#define LEMON_FIB_HEAP_H


			




	21
	21
	
		

			




	22
	22
	
		
///\file


			




	23
	
	
		
///\ingroup auxdat


			




	
	23
	
		
///\ingroup heaps


			




	24
	24
	
		
///\brief Fibonacci heap implementation.


			




	25
	25
	
		

			




	26
	26
	
		
#include <vector>


			




	27
	27
	
		
#include <utility>


			




	...
	...
	
		
@@ -29,9 +29,9 @@


			




	29
	29
	
		
#include <lemon/math.h>


			




	30
	30
	
		

			




	31
	31
	
		
namespace lemon {


			




	32
	32
	
		

			




	33
	
	
		
  /// \ingroup auxdat


			




	
	33
	
		
  /// \ingroup heaps


			




	34
	34
	
		
  ///


			




	35
	35
	
		
  /// \brief Fibonacci heap data structure.


			




	36
	36
	
		
  ///


			




	37
	37
	
		
  /// This class implements the \e Fibonacci \e heap data structure.

			




        

    

    

    

        

            

                

                    lemon/radix_heap.h
                

                

                  
                  
                  
                  Ignore white space
                  6 line context
                

                
                  
                
            

        

        

            

            



	...
	...
	
		
@@ -18,9 +18,9 @@


			




	18
	18
	
		

			




	19
	19
	
		
#ifndef LEMON_RADIX_HEAP_H


			




	20
	20
	
		
#define LEMON_RADIX_HEAP_H


			




	21
	21
	
		

			




	22
	
	
		
///\ingroup auxdat


			




	
	22
	
		
///\ingroup heaps


			




	23
	23
	
		
///\file


			




	24
	24
	
		
///\brief Radix heap implementation.


			




	25
	25
	
		

			




	26
	26
	
		
#include <vector>


			




	...
	...
	
		
@@ -28,9 +28,9 @@


			




	28
	28
	
		

			




	29
	29
	
		
namespace lemon {


			




	30
	30
	
		

			




	31
	31
	
		

			




	32
	
	
		
  /// \ingroup auxdat


			




	
	32
	
		
  /// \ingroup heaps


			




	33
	33
	
		
  ///


			




	34
	34
	
		
  /// \brief Radix heap data structure.


			




	35
	35
	
		
  ///


			




	36
	36
	
		
  /// This class implements the \e radix \e heap data structure.


			




        

    






    
    



    


    

     
    
0 comments (0 inline)