Frontiers.Queue (Rushhour API)

java.lang.Object

search.Frontiers.Queue<Node>

All Implemented Interfaces:: FrontierCheckingStructure<Node>, FrontierStructure<Node>

Enclosing class:: Frontiers

public static class Frontiers.Queue<Node>
extends Object
implements FrontierCheckingStructure<Node>

A queue as a priority queue, for e.g. BFS.

Constructor Summary

Constructors

Constructor Description

Queue()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Node n)`	Adds a (usually newly-generated) tree node to the frontier.
`boolean`	`contains(Node n)`
`int`	`countOpen()`	Returns the number of open nodes sitting unexpanded in the frontier.
`boolean`	`isEmpty()`	Checks whether any tree nodes remain in the frontier
`Node`	`pop()`	Removes one tree node from the frontier, and returns it.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface search.FrontierStructure

debugDisplayFrontier

Constructor Details
- Queue
  
  public Queue()
Method Details
- add
  
  public void add(Node n)
  
  Description copied from interface: FrontierStructure
  
  Adds a (usually newly-generated) tree node to the frontier.
  
  Specified by:
  
  add in interface FrontierStructure<Node>
  
  Parameters:
  
  n - The new node
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from interface: FrontierStructure
  
  Checks whether any tree nodes remain in the frontier
  
  Specified by:
  
  isEmpty in interface FrontierStructure<Node>
  
  Returns:
  
  false when the frontier is empty, which generally indicates that the search has failed.
- pop
  
  public Node pop()
  
  Description copied from interface: FrontierStructure
  
  Removes one tree node from the frontier, and returns it.
  
  Specified by:
  
  pop in interface FrontierStructure<Node>
  
  Returns:
  
  The dequeued tree node
- countOpen
  
  public int countOpen()
  
  Description copied from interface: FrontierStructure
  
  Returns the number of open nodes sitting unexpanded in the frontier.
  
  Specified by:
  
  countOpen in interface FrontierStructure<Node>
  
  Returns:
  
  The number of open nodes
- contains
  
  public boolean contains(Node n)
  
  Specified by:
  
  contains in interface FrontierCheckingStructure<Node>