org.kynosarges.tektosyne.subdivision

Class VoronoiMap

java.lang.Object

org.kynosarges.tektosyne.subdivision.VoronoiMap

All Implemented Interfaces:

SubdivisionMap<java.lang.Integer>

public class VoronoiMap
extends java.lang.Object
implements SubdivisionMap<java.lang.Integer>

Maps the faces of a planar Subdivision to VoronoiResults.generatorSites indices. Provides a mapping between all faces of a planar Subdivision and the VoronoiResults.generatorSites indices of the VoronoiResults from which the Subdivision was created.

The mapping is realized by a pair of arrays for optimal runtime efficiency. However, VoronoiMap will not reflect changes to the underlying Subdivision.

Constructor Summary

Constructors

Constructor and Description
VoronoiMap(VoronoiResults results) Creates a VoronoiMap from a new Subdivision to the specified VoronoiResults.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	fromFace(SubdivisionFace face) Converts the specified SubdivisionFace into the associated VoronoiResults.generatorSites index.
Subdivision	source() Gets the Subdivision that contains all mapped Subdivision.faces().
VoronoiResults	target() Gets the VoronoiResults that defines all mapped VoronoiResults.generatorSites indices.
SubdivisionFace	toFace(int value) Converts the specified VoronoiResults.generatorSites index into the associated SubdivisionFace.
SubdivisionFace	toFace(java.lang.Integer value) Converts the specified VoronoiResults.generatorSites index into the associated SubdivisionFace.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoronoiMap

public VoronoiMap(VoronoiResults results)

Creates a VoronoiMap from a new Subdivision to the specified VoronoiResults. The bounded Subdivision.faces() of the new Subdivision correspond to the VoronoiResults.voronoiRegions() of the specified results.

All VoronoiResults.voronoiRegions() are calculated if necessary. After the VoronoiMap has been created, you may call VoronoiResults.clearVoronoiRegions() if you do not otherwise require this data.

Parameters:

results - the VoronoiResults that defines all mapped VoronoiResults.generatorSites indices

Throws:

java.lang.NullPointerException - if results is null

Method Detail

target

public VoronoiResults target()

Gets the VoronoiResults that defines all mapped VoronoiResults.generatorSites indices.

Specified by:

target in interface SubdivisionMap<java.lang.Integer>

Returns:

the VoronoiResults that defines all VoronoiResults.generatorSites indices returned and accepted by fromFace(org.kynosarges.tektosyne.subdivision.SubdivisionFace) and toFace(java.lang.Integer), respectively

source

public Subdivision source()

Gets the Subdivision that contains all mapped Subdivision.faces().

Specified by:

source in interface SubdivisionMap<java.lang.Integer>

Returns:

the Subdivision that contains all Subdivision.faces() accepted and returned by fromFace(org.kynosarges.tektosyne.subdivision.SubdivisionFace) and toFace(java.lang.Integer), respectively

fromFace

public java.lang.Integer fromFace(SubdivisionFace face)

Converts the specified SubdivisionFace into the associated VoronoiResults.generatorSites index.

Specified by:

fromFace in interface SubdivisionMap<java.lang.Integer>

Parameters:

face - the SubdivisionFace to convert

Returns:

the VoronoiResults.generatorSites index associated with face

Throws:

java.lang.ArrayIndexOutOfBoundsException - if face is the unbounded SubdivisionFace, or its SubdivisionFace.key() is greater than the number of VoronoiResults.generatorSites

java.lang.NullPointerException - if face is null

toFace

public SubdivisionFace toFace(java.lang.Integer value)

Converts the specified VoronoiResults.generatorSites index into the associated SubdivisionFace.

Specified by:

toFace in interface SubdivisionMap<java.lang.Integer>

Parameters:

value - the VoronoiResults.generatorSites index to convert

Returns:

the SubdivisionFace associated with value

Throws:

java.lang.ArrayIndexOutOfBoundsException - if value is not a valid VoronoiResults.generatorSites index

toFace

public SubdivisionFace toFace(int value)

Converts the specified VoronoiResults.generatorSites index into the associated SubdivisionFace. Overload typed with a primitive int parameter to avoid Integer boxing.

Parameters:

value - the VoronoiResults.generatorSites index to convert

Returns:

the SubdivisionFace associated with value

Throws:

java.lang.ArrayIndexOutOfBoundsException - if value is not a valid VoronoiResults.generatorSites index