KSLCore/ksl.modeling.spatial/Euclidean2DPlane

Euclidean2DPlane

class Euclidean2DPlane : SpatialModel(source)

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
inner class Point(val x: Double, val y: Double, aName: String? = null) : SpatialModel.AbstractLocation

Represents a location within this spatial model.

Properties

Link copied to clipboard
open override var defaultLocation: LocationIfc

The default initial location.

Link copied to clipboard

Functions

Link copied to clipboard
open override fun compareLocations(firstLocation: LocationIfc, secondLocation: LocationIfc): Boolean

Returns true if firstLocation is the same as secondLocation within the underlying spatial model. This is not object reference equality, but rather whether the locations within the underlying spatial model can be considered spatially (equivalent) according to the model. This may or may not imply that the distance between the locations is zero. No assumptions about distance are implied by true.

Link copied to clipboard
open override fun distance(fromLocation: LocationIfc, toLocation: LocationIfc): Double

Computes the distance between fromLocation and toLocation based on the spatial model's distance metric