Class MapElementGridSet<P extends MapElement>
- java.lang.Object
-
- org.arakhne.afc.gis.grid.AbstractGISGridSet<P>
-
- org.arakhne.afc.gis.grid.MapElementGridSet<P>
-
- Type Parameters:
P
- is the type of the user data inside the node.
- All Implemented Interfaces:
Iterable<P>
,Collection<P>
,Set<P>
,GISElementSet<P>
,GISSet<P>
- Direct Known Subclasses:
MapPolylineGridSet
public class MapElementGridSet<P extends MapElement> extends AbstractGISGridSet<P> implements GISElementSet<P>
This class describes a grid that contains map elements and that permits to find them according to there geo-location.- Since:
- 14.0
- Version:
- 17.0 2020-01-04 14:41:53
- Author:
- Stéphane GALLAND
- See Also:
GISPrimitive
- Maven Group Id:
- org.arakhne.afc.gis
- Maven Artifact Id:
- giscore
-
-
Field Summary
-
Fields inherited from class org.arakhne.afc.gis.grid.AbstractGISGridSet
grid
-
-
Constructor Summary
Constructors Constructor Description MapElementGridSet(int nRows, int nColumns, double boundsX, double boundsY, double boundsWidth, double boundsHeight)
Constructor.MapElementGridSet(int nRows, int nColumns, Rectangle2d bounds)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(P point)
P
getNearest(double x, double y)
Replies the nearest object from the specified point.P
getNearest(Point2D<?,?> position)
Replies the nearest object from the specified point.org.eclipse.xtext.xbase.lib.Pair<P,Double>
getNearestData(double x, double y)
Replies the nearest object from the specified point, and its distance to the point.org.eclipse.xtext.xbase.lib.Pair<P,Double>
getNearestData(Point2D<?,?> position)
Replies the nearest object from the specified point, and its distance to the point.-
Methods inherited from class org.arakhne.afc.gis.grid.AbstractGISGridSet
addAll, boundsIterator, clear, computeSize, contains, containsAll, extractClassFrom, get, get, get, getBounds, getColumnCount, getElementType, getRowCount, indexOf, isEmpty, isTypeRecomputedAfterRemoval, iterator, iterator, iterator, remove, removeAll, retainAll, setTypeRecomputedAfterRemoval, size, slowContains, toArray, toArray, toIterable, toIterable, updateComponentType, updateComponentType
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface org.arakhne.afc.gis.GISSet
boundsIterator, computeSize, get, get, get, getElementType, indexOf, isTypeRecomputedAfterRemoval, iterator, iterator, setTypeRecomputedAfterRemoval, slowContains, toIterable, toIterable
-
-
-
-
Constructor Detail
-
MapElementGridSet
public MapElementGridSet(int nRows, int nColumns, double boundsX, double boundsY, double boundsWidth, double boundsHeight)
Constructor.- Parameters:
nRows
- numbers of rows in the gridnColumns
- numbers of columns in the gridboundsX
- is the bounds of the scene.boundsY
- is the bounds of the scene.boundsWidth
- is the bounds of the scene.boundsHeight
- is the bounds of the scene.
-
MapElementGridSet
public MapElementGridSet(int nRows, int nColumns, Rectangle2d bounds)
Constructor.- Parameters:
nRows
- numbers of rows in the gridnColumns
- numbers of columns in the gridbounds
- are the bounds of the scene stored inside this tree.
-
-
Method Detail
-
add
public boolean add(P point)
- Specified by:
add
in interfaceCollection<P extends MapElement>
- Specified by:
add
in interfaceSet<P extends MapElement>
-
getNearest
@Pure public final P getNearest(Point2D<?,?> position)
Description copied from interface:GISElementSet
Replies the nearest object from the specified point.- Specified by:
getNearest
in interfaceGISElementSet<P extends MapElement>
- Parameters:
position
- is the position from which the nearest primitive must be replied.- Returns:
- the nearest element or
null
if none. - See Also:
GISElementSet.getNearestData(Point2D)
-
getNearest
@Pure public final P getNearest(double x, double y)
Description copied from interface:GISElementSet
Replies the nearest object from the specified point.- Specified by:
getNearest
in interfaceGISElementSet<P extends MapElement>
- Parameters:
x
- is the position from which the nearest primitive must be replied.y
- is the position from which the nearest primitive must be replied.- Returns:
- the nearest element or
null
if none. - See Also:
GISElementSet.getNearestData(double, double)
-
getNearestData
@Pure public final org.eclipse.xtext.xbase.lib.Pair<P,Double> getNearestData(double x, double y)
Description copied from interface:GISElementSet
Replies the nearest object from the specified point, and its distance to the point.The nearest neighbor (NN) algorithm, to find the NN to a given target point not in the tree, relies on the ability to discard large portions of the tree by performing a simple test. To perform the NN calculation, the tree is searched in a depth-first fashion, refining the nearest distance. First the root node is examined with an initial assumption that the smallest distance to the next point is infinite. The subdomain (right or left), which is a hyperrectangle, containing the target point is searched. This is done recursively until a final minimum region containing the node is found. The algorithm then (through recursion) examines each parent node, seeing if it is possible for the other domain to contain a point that is closer. This is performed by testing for the possibility of intersection between the hyperrectangle and the hypersphere (formed by target node and current minimum radius). If the rectangle that has not been recursively examined yet does not intersect this sphere, then there is no way that the rectangle can contain a point that is a better nearest neighbour. This is repeated until all domains are either searched or discarded, thus leaving the nearest neighbour as the final result. In addition to this one also has the distance to the nearest neighbour on hand as well. Finding the nearest point is an O(logN) operation.
- Specified by:
getNearestData
in interfaceGISElementSet<P extends MapElement>
- Parameters:
x
- is the position from which the nearest primitive must be replied.y
- is the position from which the nearest primitive must be replied.- Returns:
- the nearest element and its distance to the given coordinates;
or
null
if none. - See Also:
GISElementSet.getNearest(double, double)
-
getNearestData
@Pure public org.eclipse.xtext.xbase.lib.Pair<P,Double> getNearestData(Point2D<?,?> position)
Description copied from interface:GISElementSet
Replies the nearest object from the specified point, and its distance to the point.- Specified by:
getNearestData
in interfaceGISElementSet<P extends MapElement>
- Parameters:
position
- is the position from which the nearest primitive must be replied.- Returns:
- the nearest element and its distance to the given coordinates;
or
null
if none. - See Also:
GISElementSet.getNearest(Point2D)
-
-