PolicyPoolJPolValPair Class Reference

PolicyPoolJPolValPair is a policy pool with joint policy - value pairs. More...

#include <PolicyPoolJPolValPair.h>

Inheritance diagram for PolicyPoolJPolValPair:

Public Member Functions
PolicyPoolItemInterface_sharedPtr	GetBestRanked () const
	returns the contained item with the highest value. More...
void	Init (const Interface_ProblemToPolicyDiscretePure *pu)
	initializes the policy pool with the empty joint policy and a heuristic value set to infinuty (i.e., DBL_MAX) More...
void	Insert (PolicyPoolItemInterface_sharedPtr ppi)
	Add a PolicyPoolItem to the Pool. More...
PolicyPoolJPolValPair &	operator= (const PolicyPoolJPolValPair &o)
	Copy assignment operator. More...
PolicyPoolInterface &	operator= (const PolicyPoolInterface &o)
	Copy assignment operator. More...
	PolicyPoolJPolValPair ()
	(default) Constructor More...
void	Pop ()
	Removes the item returned by 'Select'. More...
void	PopBestRanked ()
	remove the GetBestRanked() item More...
void	Prune (double v)
	prune the items in the policy pool with exp.value < v More...
PolicyPoolItemInterface_sharedPtr	Select () const
	The 'Select' operator from refGMAA. More...
size_t	Size () const
	return the number of items in the policy pool More...
void	Union (PolicyPoolInterface_sharedPtr pp)
	add all elements of pp to 'this'. More...
	~PolicyPoolJPolValPair ()
	Destructor. More...
Public Member Functions inherited from PolicyPoolInterface
size_t	Empty () const
	return whether the number of items in the policy pool is 0 More...
virtual	~PolicyPoolInterface ()
	(default) Constructor More...

Private Attributes
std::priority_queue < JointPolicyValuePair_sharedPtr > *	_m_jpvpQueue_p
	The pointer to the JointPolicyValuePair queue. More...

Detailed Description

PolicyPoolJPolValPair is a policy pool with joint policy - value pairs.

Constructor & Destructor Documentation

PolicyPoolJPolValPair::PolicyPoolJPolValPair

(

)

(default) Constructor

PolicyPoolJPolValPair::~PolicyPoolJPolValPair

(

)

Destructor.

Member Function Documentation

PolicyPoolItemInterface_sharedPtr PolicyPoolJPolValPair::GetBestRanked ( ) const

inlinevirtual

returns the contained item with the highest value.

This function returns a pointer to the PolicyPoolItemInterface contained in this Policy pool with the highest (heuristic) value.

Heuristic is between brackets, because this function is typically used when we found lower bounds (i.e. full policies) and then select the maximum lowerbound.

Because this class always 'select's the best ranked policy, this function does the same as 'Select()'.

Implements PolicyPoolInterface.

References Select().

void PolicyPoolJPolValPair::Init ( const Interface_ProblemToPolicyDiscretePure *  pu )

virtual

initializes the policy pool with the empty joint policy and a heuristic value set to infinuty (i.e., DBL_MAX)

A pointer to a Interface_ProblemToPolicyDiscretePure is needed to create the joint policy.

Implements PolicyPoolInterface.

References PolicyGlobals::OHIST_INDEX.

void PolicyPoolJPolValPair::Insert ( PolicyPoolItemInterface_sharedPtr  ppi )

virtual

Add a PolicyPoolItem to the Pool.

...

Implements PolicyPoolInterface.

PolicyPoolJPolValPair & PolicyPoolJPolValPair::operator=

(

const PolicyPoolJPolValPair &

o

)

Copy assignment operator.

References DEBUG_PPJPVP_ASSIGN.

PolicyPoolInterface & PolicyPoolJPolValPair::operator= ( const PolicyPoolInterface &  o )

virtual

Copy assignment operator.

This must be implemented by the derived class (with this prototype). For an example, see PolicyPoolJPolValPair.

For now, this function is purely abstract. Might there be some members added to this (base) class, then an implementation could be made. This should then be called using PolicyPoolInterface::operator=(o) from the copy assignment operator of the derived class. See also http://www.icu-project.org/docs/papers/cpp_report/the_assignment_operator_revisited.html.

Implements PolicyPoolInterface.

References DEBUG_PPJPVP_ASSIGN.

void PolicyPoolJPolValPair::Pop ( )

virtual

Removes the item returned by 'Select'.

This removes the next PolicyPoolItem (a wrapper for a partial joint policy, together with some properties), as would be returned by 'Select'.

Implements PolicyPoolInterface.

Referenced by PopBestRanked().

void PolicyPoolJPolValPair::PopBestRanked ( )

inlinevirtual

remove the GetBestRanked() item

Removes the PolicyPoolItemInterface contained in this Policy pool with the highest (heuristic) value. (as is returned by GetBestRanked() )

Because this class always 'select's the best ranked policy, this function does the same as 'Pop()'.

Implements PolicyPoolInterface.

References Pop().

void PolicyPoolJPolValPair::Prune ( double  v )

virtual

prune the items in the policy pool with exp.value < v

...

Implements PolicyPoolInterface.

PolicyPoolItemInterface_sharedPtr PolicyPoolJPolValPair::Select ( ) const

virtual

The 'Select' operator from refGMAA.

This returns a reference to the next PolicyPoolItem (a wrapper for a partial joint policy, together with some properties).

The returned PolicyPoolItem is not removed from the PolicyPool.

Implements PolicyPoolInterface.

Referenced by GetBestRanked().

size_t PolicyPoolJPolValPair::Size ( ) const

inlinevirtual

return the number of items in the policy pool

...

Implements PolicyPoolInterface.

void PolicyPoolJPolValPair::Union ( PolicyPoolInterface_sharedPtr  pp )

virtual

add all elements of pp to 'this'.

Note, that the pool pp is emptied in this process.

Implements PolicyPoolInterface.

References _m_jpvpQueue_p.

Member Data Documentation

std::priority_queue<JointPolicyValuePair_sharedPtr>* PolicyPoolJPolValPair::_m_jpvpQueue_p

private

The pointer to the JointPolicyValuePair queue.

Referenced by Union().