Geometry.Point (Geometry v1.1.0)

A point struct, representing a 2D point.

Summary

t()

new()

Creates an empty Point.

new(coordinate)

Creates a Point from the given coordinate.

Creates a Point from the given x and y, or a coordinate and an srid

new(x, y, srid)

Creates a Point from the given x and y.

@type t() :: %Geometry.Point{
  coordinates: Geometry.coordinates() | [],
  srid: Geometry.srid()
}

@spec new() :: t()

Creates an empty Point.

iex> Point.new()
%Point{coordinates: []}

@spec new(Geometry.coordinates()) :: t()

Creates a Point from the given coordinate.

iex> Point.new([1.5, -2.1])
%Point{coordinates: [1.5, -2.1], srid: 0}

@spec new(Geometry.coordinates() | [], Geometry.srid()) :: t()

@spec new(number(), number()) :: t()

Creates a Point from the given x and y, or a coordinate and an srid

iex> Point.new(-1.1, 2.2)
%Point{coordinates: [-1.1, 2.2], srid: 0}

@spec new(number(), number(), Geometry.srid()) :: t()

Creates a Point from the given x and y.

iex> Point.new(-1.1, 2.2, 4326)
%Point{coordinates: [-1.1, 2.2], srid: 4326}