A simple Heap class. More...

#include <OpenClosedList.h>

Public Member Functions
	OpenClosedList ()

	~OpenClosedList ()

void	reset ()
	Remove all objects from queue. More...

void	Add (OBJ val)
	Add object into OpenClosedList. More...

void	DecreaseKey (OBJ val)
	Indicate that the key for a particular object has decreased. More...

void	IncreaseKey (OBJ val)
	Indicate that the key for a particular object has increased. More...

bool	IsIn (const OBJ val) const
	Returns true if the object is in the OpenClosedList. More...

OBJ	Remove ()
	Remove the item with the lowest key from the OpenClosedList & re-heapify. More...

void	pop ()

const OBJ	peek () const

OBJ	top ()

OBJ	find (OBJ val)
	find this object in the Heap and return More...

bool	Empty ()
	Returns true if no items are in the OpenClosedList. More...

unsigned	size ()

Private Types
typedef std::unordered_map< OBJ, unsigned int, HashKey, EqKey >	IndexTable

Private Member Functions
void	HeapifyUp (unsigned int index)
	‍** More...

void	HeapifyDown (unsigned int index)

Private Attributes
std::vector< OBJ >	_elts

IndexTable	table

Detailed Description

template<typename OBJ, class HashKey, class EqKey, class CmpKey>
class OpenClosedList< OBJ, HashKey, EqKey, CmpKey >

A simple Heap class.

Definition at line 27 of file OpenClosedList.h.

Member Typedef Documentation

◆ IndexTable

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

typedef std::unordered_map<OBJ, unsigned int, HashKey, EqKey > OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::IndexTable

private

Definition at line 48 of file OpenClosedList.h.

Constructor & Destructor Documentation

◆ OpenClosedList()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::OpenClosedList

Definition at line 54 of file OpenClosedList.h.

◆ ~OpenClosedList()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::~OpenClosedList

Definition at line 59 of file OpenClosedList.h.

Member Function Documentation

◆ Add()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::Add ( OBJ val )

Add object into OpenClosedList.

Definition at line 77 of file OpenClosedList.h.

Referenced by IRDijkstra::DoOneSearchStep(), IRAStar::DoOneSearchStep(), MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), IRDijkstra::ExpandNeighbors(), IRAStar::ExpandNeighbors(), IRDijkstra::ExtractAndRefinePath(), IRAStar::ExtractAndRefinePath(), IRDijkstra::InitializeSearch(), IRAStar::InitializeSearch(), CFOptimalRefinement::InitializeSearch(), MeroB::InitializeSearch(), IRDijkstra::RefineNode(), CFOptimalRefinement::RefineNode(), and CFOptimalRefinement::UpdateNode().

◆ DecreaseKey()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::DecreaseKey ( OBJ val )

Indicate that the key for a particular object has decreased.

Definition at line 96 of file OpenClosedList.h.

Referenced by MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), IRDijkstra::ExpandNeighbors(), IRAStar::ExpandNeighbors(), IRAStar::Inconsistent(), and CFOptimalRefinement::MakeNeighborsOpen().

◆ Empty()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

bool OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::Empty

Returns true if no items are in the OpenClosedList.

Definition at line 174 of file OpenClosedList.h.

◆ find()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

OBJ OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::find ( OBJ val )

find this object in the Heap and return

Definition at line 163 of file OpenClosedList.h.

Referenced by MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), and MeroB::ExtractPathToStart().

◆ HeapifyDown()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::HeapifyDown ( unsigned int index )

private

Definition at line 215 of file OpenClosedList.h.

◆ HeapifyUp()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::HeapifyUp ( unsigned int index )

private

‍**

Definition at line 195 of file OpenClosedList.h.

◆ IncreaseKey()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::IncreaseKey ( OBJ val )

Indicate that the key for a particular object has increased.

Definition at line 109 of file OpenClosedList.h.

Referenced by MeroB::DoSingleStepBP().

◆ IsIn()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

bool OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::IsIn ( const OBJ val ) const

Returns true if the object is in the OpenClosedList.

Definition at line 121 of file OpenClosedList.h.

Referenced by MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), IRDijkstra::ExpandNeighbors(), IRAStar::ExpandNeighbors(), IRAStar::Inconsistent(), IRDijkstra::OpenGLDraw(), and IRAStar::OpenGLDraw().

◆ peek()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

const OBJ OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::peek ( ) const

inline

Definition at line 38 of file OpenClosedList.h.

Referenced by IRDijkstra::OpenGLDraw(), IRAStar::OpenGLDraw(), and CFOptimalRefinement::OpenGLDraw().

◆ pop()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::pop ( )

inline

Definition at line 37 of file OpenClosedList.h.

Referenced by IRDijkstra::DoOneSearchStep(), IRAStar::DoOneSearchStep(), and CFOptimalRefinement::DoOneSearchStep().

◆ Remove()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

OBJ OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::Remove

Remove the item with the lowest key from the OpenClosedList & re-heapify.

Definition at line 143 of file OpenClosedList.h.

Referenced by MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), and OpenClosedList< CFOptimalRefinementConstants::GNode, CFOptimalRefinementConstants::NodeHash, CFOptimalRefinementConstants::NodeEqual, CFOptimalRefinementConstants::NodeCompare >::pop().

◆ reset()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

void OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::reset

Remove all objects from queue.

Definition at line 67 of file OpenClosedList.h.

Referenced by IRDijkstra::DoOneSearchStep(), IRAStar::DoOneSearchStep(), MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), IRDijkstra::ExtractAndRefinePath(), IRAStar::ExtractAndRefinePath(), IRDijkstra::InitializeSearch(), IRAStar::InitializeSearch(), and MeroB::InitializeSearch().

◆ size()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

unsigned OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::size ( )

inline

Definition at line 42 of file OpenClosedList.h.

Referenced by IRDijkstra::DoOneSearchStep(), IRAStar::DoOneSearchStep(), MeroB::DoSingleStepA(), MeroB::DoSingleStepB(), and MeroB::DoSingleStepBP().

◆ top()

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

OBJ OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::top ( )

inline

Definition at line 39 of file OpenClosedList.h.

Referenced by IRDijkstra::DoOneSearchStep(), IRAStar::DoOneSearchStep(), CFOptimalRefinement::DoOneSearchStep(), MeroB::DoSingleStepB(), MeroB::DoSingleStepBP(), and IRAStar::OpenGLDraw().

Member Data Documentation

◆ _elts

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

std::vector<OBJ> OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::_elts

private

Definition at line 45 of file OpenClosedList.h.

◆ table

template<typename OBJ , class HashKey , class EqKey , class CmpKey >

IndexTable OpenClosedList< OBJ, HashKey, EqKey, CmpKey >::table

private

Definition at line 49 of file OpenClosedList.h.

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

/home/sturtevant/nightly/hog2/algorithms/OpenClosedList.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename OBJ, class HashKey, class EqKey, class CmpKey> class OpenClosedList< OBJ, HashKey, EqKey, CmpKey >

Member Typedef Documentation

◆ IndexTable

Constructor & Destructor Documentation

◆ OpenClosedList()

◆ ~OpenClosedList()

Member Function Documentation

◆ Add()

◆ DecreaseKey()

◆ Empty()

◆ find()

◆ HeapifyDown()

◆ HeapifyUp()

◆ IncreaseKey()

◆ IsIn()

◆ peek()

◆ pop()

◆ Remove()

◆ reset()

◆ size()

◆ top()

Member Data Documentation

◆ _elts

◆ table

template<typename OBJ, class HashKey, class EqKey, class CmpKey>
class OpenClosedList< OBJ, HashKey, EqKey, CmpKey >