fr.uga.pddl4j.util

Class ParallelPlan

java.lang.Object

fr.uga.pddl4j.util.AbstractPlan

fr.uga.pddl4j.util.ParallelPlan

All Implemented Interfaces:

Plan, java.io.Serializable

public class ParallelPlan
extends AbstractPlan

This class implements a parallel plan based on the Graphplan planner semantic. A parallel plan in the Graphplan planner semantic is a sequence of sets of actionSets. Each action contained in a set are considered as unordered.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParallelPlan() Creates a new empty parallel plan.
ParallelPlan(Plan other) Creates a new parallel plan from an other.

Method Summary

Modifier and Type	Method and Description
java.util.List<BitOp>	actions() Returns the list of actions contained in the plan in the ordering of their time specifiers.
boolean	add(int time, BitOp action) Adds an action at a specified time specifier in the plan.
void	clear() Removes all the actions of the plan.
boolean	contains(int time, BitOp action) Returns if an action is contained in the plan at a specified time specifier.
boolean	equals(java.lang.Object obj) Returns if the plan is equal to an other object.
java.util.Set<BitOp>	getActionSet(int time) Returns the set of actions at a specified time specifier.
int	hashCode() Returns the hash code of this plan.
protected boolean	isTimeSpecifierOutOfBound(int time) Returns if a specified time specifier is invalid.
double	makespan() Returns the makespan of the plan.
boolean	remove(int time) Removes all the actions at a specified time specifier of the plan.
boolean	remove(int time, BitOp action) Removes an action at a specified time specifier of the plan.
java.util.Set<java.lang.Integer>	timeSpecifiers() Returns the ordered set of time specifiers used in this plan.

Methods inherited from class fr.uga.pddl4j.util.AbstractPlan

cost, isEmpty, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParallelPlan

public ParallelPlan()

Creates a new empty parallel plan.

See Also:

AbstractPlan.AbstractPlan()

ParallelPlan

public ParallelPlan(Plan other)

Creates a new parallel plan from an other. This constructor creates a deep copy of the specified plan.

Parameters:

other - the other plan.

See Also:

AbstractPlan.AbstractPlan(Plan)

Method Detail

makespan

public final double makespan()

Returns the makespan of the plan. The makespan of parallel plan is the number of parallel time step of the plan.

Returns:

the makespan of the plan.

See Also:

Plan.makespan()

timeSpecifiers

public java.util.Set<java.lang.Integer> timeSpecifiers()

Returns the ordered set of time specifiers used in this plan.

Returns:

the ordered set of time specifiers used in this plan.

See Also:

Plan.timeSpecifiers()

actions

public final java.util.List<BitOp> actions()

Returns the list of actions contained in the plan in the ordering of their time specifiers.

Returns:

the ordered set of actions of the plan.

See Also:

Plan.actions()

getActionSet

public final java.util.Set<BitOp> getActionSet(int time)

Returns the set of actions at a specified time specifier.

Parameters:

time - the time specifier.

Returns:

the set of actions at a specified time specifier or null if no actions are scheduled in the plan at the the time specifier.

See Also:

Plan.getActionSet(int)

add

public final boolean add(int time,
                         BitOp action)

Adds an action at a specified time specifier in the plan.

Parameters:

action - the action to add.

time - the time specifier of the action in the plan.

Returns:

true if the action was added; false otherwise.

See Also:

Plan.add(int, BitOp)

remove

public final boolean remove(int time,
                            BitOp action)

Removes an action at a specified time specifier of the plan.

Parameters:

action - the action to remove.

time - the time specifier of the action in the plan to remove.

Returns:

true if the action was removed; false otherwise.

See Also:

Plan.remove(int, BitOp)

remove

public final boolean remove(int time)

Removes all the actions at a specified time specifier of the plan.

Parameters:

time - the time specifier of the actions in the plan to remove.

Returns:

true if the action was removed; false otherwise.

See Also:

Plan.remove(int)

contains

public final boolean contains(int time,
                              BitOp action)

Returns if an action is contained in the plan at a specified time specifier.

Parameters:

time - the time specifier.

action - the action.

Returns:

true if the specified action is contained in the plan at the specified time specifier; false otherwise.

See Also:

Plan.contains(int, BitOp)

clear

public final void clear()

Removes all the actions of the plan.

See Also:

Plan.clear()

equals

public boolean equals(java.lang.Object obj)

Returns if the plan is equal to an other object. A plan is equal to an other object if the object is an instance of the same class and have the same action at the same time specifier. The equals method uses the equal method of the class BitOp to compare actions.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared.

Returns:

true if this plan is equal to the specified object; false otherwise.

See Also:

AbstractCodedOp.equals(Object), Object.equals(Object)

hashCode

public int hashCode()

Returns the hash code of this plan.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this plan.

See Also:

Object.hashCode()

isTimeSpecifierOutOfBound

protected final boolean isTimeSpecifierOutOfBound(int time)

Returns if a specified time specifier is invalid. Formally a time specifier is invalid if it is less than 0 or greater than the size of the plan.

Parameters:

time - the time stamp.

Returns:

true if the specified time specifier is out of bound; false otherwise.