utility::heap Class Reference

#include <heap.hh>

Inheritance diagram for utility::heap:

Public Member Functions
	heap (int max_items)
	Create a heap with this number of items. More...
virtual	~heap ()
void	heap_insert (int val, float coval, bool &err)
	Inserts a value into the heap that is sorted by coval. More...
void	heap_extract (int &val, float &coval, bool &err)
	Extracts the val,coval pair with the lowest coval from the heap. This modifies the heap, and the returned values are put into the arguments val and coval. More...
void	heap_replace (int val, float coval)
void	reset_coval (int val, float coval)
float	heap_head () const
	returns the smallest covalue stored in the heap. More...
float	coval (int index) const
int	val (int index) const
int	size () const
int	capacity () const
Public Member Functions inherited from utility::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
virtual	~ReferenceCount ()

Private Member Functions
void	heap_init (int max_items)
	sets up an empty heap and stores the dimensioned size More...
void	heap_down (int index_in)
void	heap_up (int index_in)
int &	heap_size ()
int &	heap_capacity ()
void	decrease_coval (int index, float coval)
void	increase_coval (int index, float coval)
int	index_for_val (int val)

Private Attributes
utility::vector0< int >	heap_
utility::vector0< float >	coheap_

Additional Inherited Members
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type

Constructor & Destructor Documentation

utility::heap::heap ( int  max_items )

inline

Create a heap with this number of items.

References coheap_, heap_, and heap_init().

utility::heap::~heap ( )

virtual

Member Function Documentation

int utility::heap::capacity

(

)

const

References heap_.

float utility::heap::coval

(

int

index

)

const

References coheap_, and ObjexxFCL::index().

Referenced by decrease_coval(), heap_insert(), heap_replace(), and increase_coval().

void utility::heap::decrease_coval ( int  index, float  coval  )

private

References coheap_, coval(), heap_up(), and ObjexxFCL::index().

Referenced by reset_coval().

int & utility::heap::heap_capacity ( )

private

References heap_.

Referenced by heap_init(), and heap_insert().

void utility::heap::heap_down ( int  index_in )

private

References coheap_, heap_, and heap_size().

Referenced by heap_extract(), heap_replace(), and increase_coval().

void utility::heap::heap_extract	(	int &	val,
		float &	coval,
		bool &	err
	)

Extracts the val,coval pair with the lowest coval from the heap. This modifies the heap, and the returned values are put into the arguments val and coval.

modifes heap and last_val return val and err.

References coheap_, heap_, heap_down(), and heap_size().

float utility::heap::heap_head

(

)

const

returns the smallest covalue stored in the heap.

References coheap_.

void utility::heap::heap_init ( int  max_items )

private

sets up an empty heap and stores the dimensioned size

References heap_capacity(), and heap_size().

Referenced by heap().

void utility::heap::heap_insert	(	int	val,
		float	coval,
		bool &	err
	)

Inserts a value into the heap that is sorted by coval.

modifies heap and last_dummy, inserts val, returns err requires heap_max to be previously set via heap_init

References coheap_, coval(), heap_, heap_capacity(), heap_replace(), heap_size(), heap_up(), and val().

void utility::heap::heap_replace	(	int	val,
		float	coval
	)

References coheap_, coval(), heap_, heap_down(), and val().

Referenced by heap_insert().

int & utility::heap::heap_size ( )

private

References heap_.

Referenced by heap_down(), heap_extract(), heap_init(), heap_insert(), and index_for_val().

void utility::heap::heap_up ( int  index_in )

private

References coheap_, heap_, test.T850_SubClassing::pv, and value.

Referenced by decrease_coval(), and heap_insert().

void utility::heap::increase_coval ( int  index, float  coval  )

private

References coheap_, coval(), heap_down(), and ObjexxFCL::index().

Referenced by reset_coval().

int utility::heap::index_for_val ( int  val )

private

References heap_, heap_size(), and test.T200_Scoring::ii.

Referenced by reset_coval().

void utility::heap::reset_coval	(	int	val,
		float	coval
	)

References coheap_, decrease_coval(), increase_coval(), ObjexxFCL::index(), and index_for_val().

int utility::heap::size

(

)

const

References heap_.

int utility::heap::val

(

int

index

)

const

References heap_, and ObjexxFCL::index().

Referenced by heap_insert(), and heap_replace().

Member Data Documentation

utility::vector0< float > utility::heap::coheap_

private

Referenced by coval(), decrease_coval(), heap(), heap_down(), heap_extract(), heap_head(), heap_insert(), heap_replace(), heap_up(), increase_coval(), and reset_coval().

utility::vector0< int > utility::heap::heap_

private

Referenced by capacity(), heap(), heap_capacity(), heap_down(), heap_extract(), heap_insert(), heap_replace(), heap_size(), heap_up(), index_for_val(), size(), and val().

---

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

• src/utility/heap.hh
• src/utility/heap.cc