The inner node of a tree. More...

Inheritance diagram for frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >:

[legend]

Public Member Functions
	InnerNode (int nbrOfChildren)
	A constructor.
	InnerNode (Node< U >[] children)
	A constructor.
Node< U >	getExample ()
L	getMaxUB ()
int	getMaxUBChild ()
int	getMaxChild ()
L	getMaxUtil ()
void	setUtil (int index, boolean direct)
	Set the maximal utility for this node.
void	setUB (int index, boolean direct)
	Set the maximal upper bound for this node.
void	enlargeChildrenArray (int enlargement, boolean dummy)
	If maxUBChild points to the dummy child, its value should be increased by 1.
Node< U >	getChild (int i)
	Return a specific child of this node.
void	setChild (Node< U > child, int position)
	Add a child in a particular position.
void	retainOnly (int child)
	This method is used when the assignment belonging to leaf child has been sent as a confirmed good.
boolean	utilCandidate (U maxUtil, final boolean maximize)
boolean	ubCandidate (U maxUB, final boolean maximize)
U	getUtil ()
U	getUB ()
boolean	hasUtil ()
boolean	hasUB ()
boolean	check1 ()
	If there is a util, there must be an upperbound as well.
boolean	check2 (final boolean maximize)
	Either the utility is lower than the upperbound, or the utility is not up to date.
boolean	check3 (final boolean maximize)
	Either the utility is not up to date or it is not greater than the upper bound.
boolean	check4 ()
	If there is an upper bound, and its utility is up to date, then there must also be a utility.
boolean	check5 (U[] upperBoundSums, final boolean maximize)
	Check whether the upperbound is up to date.
boolean	recalculateUtil ()
Public Member Functions inherited from frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node< U >
	Node ()
	A constructor.
Node< U >	makeDummyCopy ()
	Method used when creating a dummy part of the tree.
boolean	isAlive ()
void	setAlive (boolean alive)
	Change the alive status of this node.
boolean	utilCandidate (U maxUtil, final boolean maximize)
boolean	ubCandidate (U maxUB, boolean maximize)
U	getUtil ()
U	getUB ()
boolean	hasUtil ()
boolean	hasUB ()
boolean	recalculateUtil ()

Public Attributes
Node< U >[]	children
	The children of this node.
Public Attributes inherited from frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node< U >
boolean	alive
	False if this node leads to a path that has been deleted.

Protected Attributes
int	maxChild
	the branch from this node to the assignment that has the highest utility
int	maxUBChild
	the branch from this node to the assignment that has the highest upper bound
L	util
	The utility stored in this node.
L	UB
	The UB stored in this node.

Additional Inherited Members
Package Functions inherited from frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node< U >
public< L extends Node< U > > L	newInstance (int confirmedCounter, int[] powersOf2)
	Create a new instance of the leaf node.

Detailed Description

The inner node of a tree.

Author: brammert

Parameters

<U>	the type used to represent a utility value
<L>	the type of LeafNode that is to be used

Constructor & Destructor Documentation

◆ InnerNode() [1/2]

frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.InnerNode ( int nbrOfChildren )

A constructor.

Parameters

nbrOfChildren the number of children of this node

References children, InnerNode(), maxChild, maxUBChild, and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node().

Referenced by InnerNode(), setUB(), and setUtil().

Here is the call graph for this function:

◆ InnerNode() [2/2]

frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.InnerNode ( Node[] children )

A constructor.

Parameters

children the number of children of this node

References children, maxChild, maxUBChild, and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node().

Here is the call graph for this function:

Member Function Documentation

◆ check1()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.check1 ( )

If there is a util, there must be an upperbound as well.

Author: Brammert Ottens, 20 apr 2010

Returns: true if the test succeeds, and false otherwise

References UB, and util.

◆ check2()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.check2 ( final boolean maximize )

Either the utility is lower than the upperbound, or the utility is not up to date.

Author: Brammert Ottens, 20 apr 2010

Parameters

maximize when true we are maximizing, when false we are minimizing

Returns: true if the test succeeds, and false otherwise

References UB, and util.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree().

◆ check3()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.check3 ( final boolean maximize )

Either the utility is not up to date or it is not greater than the upper bound.

Author: Brammert Ottens, 22 apr 2010

Parameters

maximize when true we are maximizing, when false we are minimizing

Returns: true if the test succeeds and false otherwise

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath().

◆ check4()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.check4 ( )

If there is an upper bound, and its utility is up to date, then there must also be a utility.

Author: Brammert Ottens, 22 apr 2010

Returns: true if the test succeeds and false otherwise

References UB, and util.

◆ check5()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.check5	(	U[]	upperBoundSums,
		final boolean	maximize )

Check whether the upperbound is up to date.

Author: Brammert Ottens, 22 apr 2010

Parameters

upperBoundSums	the precalculated upper bound sums
maximize	when `true` we are maximizing, when `false` we are minimizing

Returns: true if the test succeeds and false otherwise

References UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath().

◆ enlargeChildrenArray()

void frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.enlargeChildrenArray	(	int	enlargement,
		boolean	dummy )

If maxUBChild points to the dummy child, its value should be increased by 1.

Parameters

enlargement	the number of children slots that need to be added
dummy	`true` when this node contains a dummy value

References children, enlargeChildrenArray(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node().

Referenced by enlargeChildrenArray().

Here is the call graph for this function:

◆ getChild()

Node frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getChild ( int i )

Return a specific child of this node.

Parameters

i	the id of the child

Returns: Node

References children, and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node().

Here is the call graph for this function:

◆ getExample()

Node frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getExample ( )

Author: Brammert Ottens, 19 nov 2009

Returns: the node that should be used as an example when adding a new domain element

References children, maxChild, maxUBChild, frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node(), and UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.addNewDomainElementNoUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.addNewDomainElementWithUB(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.initiateBounds().

Here is the call graph for this function:

◆ getMaxChild()

int frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getMaxChild ( )

Author: Brammert Ottens, 19 nov 2009

Returns: the index of the child that contains the maximal utility

◆ getMaxUB()

L frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getMaxUB ( )

Author: Brammert Ottens, 19 nov 2009

Returns: the maximal upperbound of the node

References UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.recalculateUB(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.UBexists().

◆ getMaxUBChild()

int frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getMaxUBChild ( )

Author: Brammert Ottens, 19 nov 2009

Returns: the index of the child that contains the maximal upper bound

References maxUBChild.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.addVariableToTree().

◆ getMaxUtil()

L frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getMaxUtil ( )

Author: Brammert Ottens, 19 nov 2009

Returns: the maximal utility of this node

References util.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.checkTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.Utilexists().

◆ getUB()

U frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getUB ( )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.getUB()

References UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.checkTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathWithUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathWithUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.initiateBounds(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath().

◆ getUtil()

U frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.getUtil ( )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.getUtil()

References util.

◆ hasUB()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.hasUB ( )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.hasUB()

References UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.checkTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.UBexists(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath().

◆ hasUtil()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.hasUtil ( )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.hasUtil()

References util.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.checkTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.Utilexists().

◆ recalculateUtil()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.recalculateUtil ( )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.recalculateUtil()

References util.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.recalculateUB().

◆ retainOnly()

void frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode, L extends LeafNode >.retainOnly ( int child )

This method is used when the assignment belonging to leaf child has been sent as a confirmed good.

All other children must be removed from the tree.

Parameters

child remove all children but child

References children.

◆ setChild()

void frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.setChild	(	Node< U >	child,
		int	position )

Add a child in a particular position.

Parameters

child	the child to be updated
position	the position of the child

Warning: this method overrides the previous Node in this position

References children, and frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.Node().

Here is the call graph for this function:

◆ setUB()

void frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.setUB	(	int	index,
		boolean	direct )

Set the maximal upper bound for this node.

Author: Brammert Ottens, 19 nov 2009

Parameters

index	the index of the child that contains this maximal utility
direct	`true` when all the children are leafnodes, and `false` otherwise

References children, InnerNode(), maxUBChild, setUB(), and UB.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.addVariableToTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathWithUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathWithUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.initiateBounds(), setUB(), and frodo2.algorithms.odpop.goodsTree.InnerNodeTree.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.updatePath().

Here is the call graph for this function:

◆ setUtil()

void frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.setUtil	(	int	index,
		boolean	direct )

Set the maximal utility for this node.

Author: Brammert Ottens, 19 nov 2009

Parameters

index	the index of the child that contains this maximal utility
direct	`true` when all the children are leafnodes, and `false` otherwise

References children, InnerNode(), maxChild, setUtil(), and util.

Referenced by frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.addVariableToTree(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathNoUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.createPathWithUB(), frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNodeTree< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.fillTree(), and setUtil().

Here is the call graph for this function:

◆ ubCandidate()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.ubCandidate	(	U	maxUB,
		final boolean	maximize )

See also: frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.Node.ubCandidate(frodo2.solutionSpaces.Addable, boolean)

References UB.

◆ utilCandidate()

boolean frodo2.algorithms.odpop.goodsTree.InnerNodeTreeFullDomain.InnerNode< U extends Addable< U >, L extends LeafNode< U > >.utilCandidate	(	U	maxUtil,
		final boolean	maximize )