Package net.citizensnpcs.api.astar

Class SimpleAStarStorage

java.lang.Object

net.citizensnpcs.api.astar.SimpleAStarStorage

All Implemented Interfaces:

AStarStorage

public class SimpleAStarStorage
extends Object
implements AStarStorage

A base implementation of AStarStorage that uses a PriorityQueue for the frontier and HashMaps for the open/closed sets.

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<AStarStorage>	FACTORY

Constructor Summary

Constructors

Constructor	Description
SimpleAStarStorage()

Method Summary

Modifier and Type	Method	Description
void	close(AStarNode node)	Close a given AStarNode, moving it from the open set to the closed set.
AStarNode	getBestNode()
void	open(AStarNode node)	Close a given AStarNode, moving or adding it from the frontier to the open set.
AStarNode	removeBestNode()	Returns the best node from the frontier and removes it.
boolean	shouldExamine(AStarNode neighbour)	Returns whether to examine a given AStarNode.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

FACTORY

public static final Supplier<AStarStorage> FACTORY

Constructor Details

SimpleAStarStorage

public SimpleAStarStorage()

Method Details

close

public void close(AStarNode node)

Description copied from interface: AStarStorage

Close a given AStarNode, moving it from the open set to the closed set.

Specified by:

close in interface AStarStorage

getBestNode

public AStarNode getBestNode()

Specified by:

getBestNode in interface AStarStorage

Returns:

The AStarNode to examine next from the frontier

open

public void open(AStarNode node)

Description copied from interface: AStarStorage

Close a given AStarNode, moving or adding it from the frontier to the open set.

Specified by:

open in interface AStarStorage

removeBestNode

public AStarNode removeBestNode()

Description copied from interface: AStarStorage

Returns the best node from the frontier and removes it.

Specified by:

removeBestNode in interface AStarStorage

Returns:

The AStarNode to examine next from the frontier

shouldExamine

public boolean shouldExamine(AStarNode neighbour)

Description copied from interface: AStarStorage

Returns whether to examine a given AStarNode.

Specified by:

shouldExamine in interface AStarStorage

toString

public String toString()

Overrides:

toString in class Object