PointCoordinates
open class PointCoordinates : ListBase, Sequence
Represents an N-dimensional point.
Note that some coordinate reference systems will support only x
and y
dimensions.
-
Undocumented
Declaration
Swift
public subscript(index: Int) -> Double { get set }
-
An immutable empty
PointCoordinates
.Declaration
Swift
public static let empty: PointCoordinates
-
Construct a new list with
length
of zero and optional initialcapacity
. A list can expand in length beyond its initial capacity, but best performance will be obtained if the initial capacity is close to (and not less than) the list’s maximum length.Declaration
Swift
override public init(capacity: Int = (4 as Int))
Parameters
capacity
Optional initial capacity.
-
Synonym for
z
.Declaration
Swift
open var altitude: Double { get set }
-
Add
item
to the end of this list.Declaration
Swift
public final func append(_ item: Double)
Parameters
item
Item to be added.
-
Add all the items of
list
to the end of this list.Declaration
Swift
public final func append(contentsOf list: PointCoordinates)
Parameters
list
Items to be added.
-
Declaration
Swift
public final func copy() -> PointCoordinates
Return Value
A shallow copy of this list.
-
Declaration
Swift
override open func copyMutable() -> DataValue
Return Value
A clone of this value if it (together with all value subcomponents) is possibly mutable, or return
self
value if it (together with all value subcomponents) is definitely immutable. The resulting value might share mutable metadata with this query. -
Declaration
Swift
public final func filter(_ predicate: @escaping (Double) -> Bool) -> PointCoordinates
Parameters
predicate
Function to be applied to each item of this list. Items matching this predicate will be returned in the new list.
Return Value
A new list which contains the items of this list that match a specified predicate function. Ordering is preserved.
-
Throws
EmptyListException
if the list is empty.Declaration
Swift
public final func first() -> Double
Return Value
The first item in this list.
-
Convert array to list.
Declaration
Swift
open class func fromArray(_ array: Array<Double>) -> PointCoordinates
Parameters
array
Array with source items.
Return Value
New list with items copied from
array
parameter. -
Declaration
Swift
public final func includes(item: Double) -> Bool
Parameters
item
Item for comparison. Comparison uses the
equality
property, which would usually be expected to match the==
operator for item typedouble
.Return Value
true
if this list containsitem
. -
Declaration
Swift
public final func indexOf(item: Double, start: Int = (0 as Int)) -> Int
Parameters
item
Item for comparison. Comparison uses the
equality
property, which would usually be expected to match the==
operator for item typedouble
.start
Zero-based starting index (search moves forwards from this index).
Return Value
First index in this list of
item
, or-1
if not found. -
Insert
item
into this list, before the item (if any) atindex
.Throws
ListIndexException
ifindex
is out of range (0 tolength
).Declaration
Swift
public final func insert(at index: Int, item: Double)
Parameters
index
Zero-based index.
item
Item to be added.
-
Insert all items of
list
into this list, before the item (if any) atindex
.Throws
ListIndexException
ifindex
is out of range (0 tolength
).Declaration
Swift
public final func insert(at index: Int, contentsOf list: PointCoordinates)
Parameters
index
Zero-based index.
list
List of items to be inserted.
-
Throws
ListIndexException
ifindex
is out of range (0 tolength
- 1).Declaration
Swift
public final func item(at index: Int) -> Double
Parameters
index
Zero-based index.
Return Value
The item in this list at the specified
index
. -
Throws
EmptyListException
if the list is empty.Declaration
Swift
public final func last() -> Double
Return Value
The last item in this list.
-
Declaration
Swift
public final func lastIndexOf(item: Double, start: Int = (2147483647 as Int)) -> Int
Parameters
item
Item for comparison. Comparison uses the
equality
property, which would usually be expected to match the==
operator for item typedouble
.start
Zero-based starting index (search moves backwards from this index).
Return Value
Last index in this list of
item
, or-1
if not found. -
Synonym for
y
.Declaration
Swift
open var latitude: Double { get set }
-
Synonym for
x
.Declaration
Swift
open var longitude: Double { get set }
-
The
M
dimension (e.g. measure). Equivalent tothis.last()
. UsewithXYM
orwithXYZM
to obtain point coordinates with anM
dimension.Declaration
Swift
open var m: Double { get }
-
Declaration
Swift
open func makeIterator() -> IndexingIterator<Array<Double>>
Return Value
This list converted to a Swift iterator.
-
Synonym for
m
.Declaration
Swift
open var measure: Double { get }
-
Declaration
Swift
open class func of(_ items: Double...) -> PointCoordinates
Parameters
rest_items
Items for the resulting list.
Return Value
A new list of item type
double
, containing the specifieditems
. -
See also
copy
,reverse
.Declaration
Swift
open func reversed() -> PointCoordinates
Return Value
a reversed copy of this list.
-
Return a new
PointCoordinates
that shares theListBase.untypedList
as thelist
parameter. To ensure type safety, items inlist
that do not have the item typedouble
will be removed.Declaration
Swift
open class func share(_ list: ListBase) -> PointCoordinates
Parameters
list
List whose items will be shared by the resulting list.
Return Value
A new list of item type
double
, sharing the same items aslist
. -
Throws
EmptyListException
if the list has no items,NotUniqueException
if the list has multiple items.Declaration
Swift
public final func single() -> Double
Return Value
A single item from this list.
-
Declaration
Swift
public final func slice(start: Int, end: Int = (2147483647 as Int)) -> PointCoordinates
Parameters
start
Zero-based starting index (inclusive), or negative for starting index relative to the end of this list.
end
Zero-based ending index (exclusive), or negative for ending index relative to the end of this list.
Return Value
A slice of this list from index
start
(inclusive) to indexend
(exclusive). -
Sort this list in place (stable sort, O(n log n) complexity).
See also
copy
,sort
.Declaration
Swift
public final func sort(by increasing: @escaping (Double, Double) -> Bool)
Parameters
increasing
Predicate that returns
true
if its first argument should preceed its second argument in the desired ordering. -
See also
copy
,sort
.Declaration
Swift
public final func sorted() -> PointCoordinates
Return Value
a sorted copy of this list using this list’s default
comparer
for ordering (stable sort, O(n log n) complexity). -
See also
copy
,sortBy
.Declaration
Swift
public final func sorted(by increasing: @escaping (Double, Double) -> Bool) -> PointCoordinates
Parameters
increasing
Predicate that returns
true
if its first argument should preceed its second argument in the desired ordering.Return Value
a sorted copy of this list (stable sort, O(n log n) complexity).
-
Declaration
Swift
open func toArray() -> Array<Double>
Return Value
This list converted to a Swift array.
-
Set the item in this list at the specified
index
.Declaration
Swift
public final func update(at index: Int, item: Double)
Parameters
index
Zero-based index.
item
Item value.
-
Declaration
Swift
open class func with(x: Double, y: Double) -> PointCoordinates
Parameters
x
X-coordinate (longitude for geography points).
y
Y-coordinate (latitude for geography points).
Return Value
2D point coordinates.
-
Declaration
Swift
open class func with(x: Double, y: Double, m: Double) -> PointCoordinates
Parameters
x
X-coordinate (longitude for geography points).
y
Y-coordinate (latitude for geography points).
m
M-coordinate (measure).
Return Value
2D point coordinates with measure.
-
Declaration
Swift
open class func with(x: Double, y: Double, z: Double) -> PointCoordinates
Parameters
x
X-coordinate (longitude for geography points).
y
Y-coordinate (latitude for geography points).
z
Z-coordinate (altitude for geography points).
Return Value
3D point coordinates.
-
Declaration
Swift
open class func with(x: Double, y: Double, z: Double, m: Double) -> PointCoordinates
Parameters
x
X-coordinate (longitude for geography points).
y
Y-coordinate (latitude for geography points).
z
Z-coordinate (altitude for geography points).
m
M-coordinate (measure).
Return Value
3D point coordinates with measure.
-
Declaration
Swift
open class func with(latitude: Double, longitude: Double) -> PointCoordinates
Parameters
latitude
Latitude (Y-coordinate).
longitude
Longitude (X-coordinate).
Return Value
2D point coordinates.
-
The
X
dimension (e.g. longitude). Equivalent tothis.get(0)
.Declaration
Swift
open var x: Double { get set }
-
The
Y
dimension (e.g. latitude). Equivalent tothis.get(1)
.Declaration
Swift
open var y: Double { get set }
-
The
Z
dimension (e.g. altitude). Equivalent tothis.get(2)
.Declaration
Swift
open var z: Double { get set }