Open
Graph Drawing
Framework

 v.2012.05
 

ogdf::Prioritized< X, Priority > Class Template Reference

Augments any data elements of type X with keys of type Score. More...

#include <ogdf/basic/MinHeap.h>

List of all members.

Public Member Functions

 Prioritized ()
 Constructor of empty element. Be careful!
 Prioritized (X xt, Priority pt)
 Constructor using a key/value pair.
 Prioritized (const Prioritized &P)
 Copy-constructor.
Priority priority () const
 Returns the key of the element.
item () const
 Returns the data of the element.
bool operator< (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)
bool operator<= (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)
bool operator> (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)
bool operator>= (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)
bool operator== (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)
bool operator!= (const Prioritized< X, Priority > &P) const
 Comparison oprator based on the compare-operator for the key type (Priority)

Private Attributes

x
Priority p

Detailed Description

template<class X, class Priority = double>
class ogdf::Prioritized< X, Priority >

Augments any data elements of type X with keys of type Score.

Also defines comparator function using the keys. This class is intended as a helpful convenience class for using with BinaryHeapSimple, Top10Heap,..

Definition at line 58 of file MinHeap.h.


Constructor & Destructor Documentation

template<class X, class Priority = double>
ogdf::Prioritized< X, Priority >::Prioritized ( ) [inline]

Constructor of empty element. Be careful!

Definition at line 63 of file MinHeap.h.

template<class X, class Priority = double>
ogdf::Prioritized< X, Priority >::Prioritized ( xt,
Priority  pt 
) [inline]

Constructor using a key/value pair.

Definition at line 65 of file MinHeap.h.

template<class X, class Priority = double>
ogdf::Prioritized< X, Priority >::Prioritized ( const Prioritized< X, Priority > &  P) [inline]

Copy-constructor.

Definition at line 67 of file MinHeap.h.


Member Function Documentation

template<class X, class Priority = double>
X ogdf::Prioritized< X, Priority >::item ( ) const [inline]

Returns the data of the element.

Definition at line 71 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator!= ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 83 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator< ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 73 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator<= ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 75 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator== ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 81 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator> ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 77 of file MinHeap.h.

template<class X, class Priority = double>
bool ogdf::Prioritized< X, Priority >::operator>= ( const Prioritized< X, Priority > &  P) const [inline]

Comparison oprator based on the compare-operator for the key type (Priority)

Definition at line 79 of file MinHeap.h.

template<class X, class Priority = double>
Priority ogdf::Prioritized< X, Priority >::priority ( ) const [inline]

Returns the key of the element.

Definition at line 69 of file MinHeap.h.


Member Data Documentation

template<class X, class Priority = double>
Priority ogdf::Prioritized< X, Priority >::p [private]

Definition at line 60 of file MinHeap.h.

template<class X, class Priority = double>
X ogdf::Prioritized< X, Priority >::x [private]

Definition at line 59 of file MinHeap.h.


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