Geometry.MultiPoint (Geometry v0.3.0) View Source
A set of points from type Geometry.Point
.
MultiPoint
implements the protocols Enumerable
and Collectable
.
Examples
iex> Enum.map(
...> MultiPoint.new([
...> Point.new(1, 2),
...> Point.new(3, 4)
...> ]),
...> fn [x, _y] -> x end
...> )
[1, 3]
iex> Enum.into([Point.new(1, 2)], MultiPoint.new())
%MultiPoint{
points:
MapSet.new([
[1, 2]
])
}
Link to this section Summary
Functions
Returns true
if the given MultiPoint
is empty.
Creates a MultiPoint
from the given coordinates.
Returns an :ok
tuple with the MultiPoint
from the given GeoJSON term.
Otherwise returns an :error
tuple.
The same as from_geo_json/1
, but raises a Geometry.Error
exception if it fails.
Returns an :ok
tuple with the MultiPoint
from the given WKB string. Otherwise
returns an :error
tuple.
The same as from_wkb/2
, but raises a Geometry.Error
exception if it fails.
Returns an :ok
tuple with the MultiPoint
from the given WKT string.
Otherwise returns an :error
tuple.
The same as from_wkt/1
, but raises a Geometry.Error
exception if it fails.
Checks if MulitPoint
contains point
.
Creates an empty MultiPoint
.
Creates a MultiPoint
from the given Geometry.Point
s.
Returns the number of elements in MultiPoint
.
Returns the GeoJSON term of a MultiPoint
.
Converts MultiPoint
to a list.
Returns the WKB representation for a MultiPoint
.
Returns the WKT representation for a MultiPoint
. With option :srid
an
EWKT representation with the SRID is returned.
Link to this section Types
Specs
t() :: %Geometry.MultiPoint{points: MapSet.t(Geometry.coordinate())}
Link to this section Functions
Specs
Returns true
if the given MultiPoint
is empty.
Examples
iex> MultiPoint.empty?(MultiPoint.new())
true
iex> MultiPoint.empty?(
...> MultiPoint.new(
...> [Point.new(1, 2), Point.new(3, 4)]
...> )
...> )
false
Specs
from_coordinates([Geometry.coordinate()]) :: t()
Creates a MultiPoint
from the given coordinates.
Examples
iex> MultiPoint.from_coordinates(
...> [[-1, 1], [-2, 2], [-3, 3]]
...> )
%MultiPoint{
points: MapSet.new([
[-1, 1],
[-2, 2],
[-3, 3]
])
}
iex> MultiPoint.from_coordinates(
...> [[-1, 1], [-2, 2], [-3, 3]]
...> )
%MultiPoint{
points: MapSet.new([
[-1, 1],
[-2, 2],
[-3, 3]
])
}
Specs
from_geo_json(Geometry.geo_json_term()) :: {:ok, t()} | Geometry.geo_json_error()
Returns an :ok
tuple with the MultiPoint
from the given GeoJSON term.
Otherwise returns an :error
tuple.
Examples
iex> ~s(
...> {
...> "type": "MultiPoint",
...> "coordinates": [
...> [1.1, 1.2],
...> [20.1, 20.2]
...> ]
...> }
...> )
iex> |> Jason.decode!()
iex> |> MultiPoint.from_geo_json()
{:ok, %MultiPoint{points: MapSet.new([
[1.1, 1.2],
[20.1, 20.2]
])}}
Specs
from_geo_json!(Geometry.geo_json_term()) :: t()
The same as from_geo_json/1
, but raises a Geometry.Error
exception if it fails.
Specs
from_wkb(Geometry.wkb(), Geometry.mode()) :: {:ok, t() | {t(), Geometry.srid()}} | Geometry.wkb_error()
Returns an :ok
tuple with the MultiPoint
from the given WKB string. Otherwise
returns an :error
tuple.
If the geometry contains a SRID the id is added to the tuple.
An example of a simpler geometry can be found in the description for the
Geometry.Point.from_wkb/2
function.
Specs
from_wkb!(Geometry.wkb(), Geometry.mode()) :: t() | {t(), Geometry.srid()}
The same as from_wkb/2
, but raises a Geometry.Error
exception if it fails.
Specs
from_wkt(Geometry.wkt()) :: {:ok, t() | {t(), Geometry.srid()}} | Geometry.wkt_error()
Returns an :ok
tuple with the MultiPoint
from the given WKT string.
Otherwise returns an :error
tuple.
If the geometry contains a SRID the id is added to the tuple.
Examples
iex> MultiPoint.from_wkt(
...> "MultiPoint (-5.1 7.8, 0.1 0.2)"
...> )
{:ok, %MultiPoint{
points: MapSet.new([
[-5.1, 7.8],
[0.1, 0.2]
])
}}
iex> MultiPoint.from_wkt(
...> "SRID=7219;MultiPoint (-5.1 7.8, 0.1 0.2)"
...> )
{:ok, {
%MultiPoint{
points: MapSet.new([
[-5.1, 7.8],
[0.1, 0.2]
])
},
7219
}}
iex> MultiPoint.from_wkt("MultiPoint EMPTY")
...> {:ok, %MultiPoint{}}
Specs
from_wkt!(Geometry.wkt()) :: t() | {t(), Geometry.srid()}
The same as from_wkt/1
, but raises a Geometry.Error
exception if it fails.
Specs
member?(t(), Geometry.Point.t()) :: boolean()
Checks if MulitPoint
contains point
.
Examples
iex> MultiPoint.member?(
...> MultiPoint.new([
...> Point.new(11, 12),
...> Point.new(21, 22)
...> ]),
...> Point.new(11, 12)
...> )
true
iex> MultiPoint.member?(
...> MultiPoint.new([
...> Point.new(11, 12),
...> Point.new(21, 22)
...> ]),
...> Point.new(1, 2)
...> )
false
Specs
new() :: t()
Creates an empty MultiPoint
.
Examples
iex> MultiPoint.new()
%MultiPoint{points: MapSet.new()}
Specs
new([Geometry.Point.t()]) :: t()
Creates a MultiPoint
from the given Geometry.Point
s.
Examples
iex> MultiPoint.new([
...> Point.new(1, 2),
...> Point.new(1, 2),
...> Point.new(3, 4)
...> ])
%MultiPoint{points: MapSet.new([
[1, 2],
[3, 4]
])}
iex> MultiPoint.new([])
%MultiPoint{points: MapSet.new()}
Specs
size(t()) :: non_neg_integer()
Returns the number of elements in MultiPoint
.
Examples
iex> MultiPoint.size(
...> MultiPoint.new([
...> Point.new(11, 12),
...> Point.new(21, 22)
...> ])
...> )
2
Specs
to_geo_json(t()) :: Geometry.geo_json_term()
Returns the GeoJSON term of a MultiPoint
.
There are no guarantees about the order of points in the returned
coordinates
.
Examples
MultiPoint.to_geo_json(
MultiPoint.new([
Point.new(-1.1, -2.2),
Point.new(1.1, 2.2)
])
)
# =>
# %{
# "type" => "MultiPoint",
# "coordinates" => [
# [-1.1, -2.2],
# [1.1, 2.2]
# ]
# }
Specs
to_list(t()) :: [Geometry.Point.t()]
Converts MultiPoint
to a list.
Examples
iex> MultiPoint.to_list(
...> MultiPoint.new([
...> Point.new(11, 12),
...> Point.new(21, 22)
...> ])
...> )
[
[11, 12],
[21, 22]
]
Specs
to_wkb(t(), opts) :: Geometry.wkb() when opts: [ endian: Geometry.endian(), srid: Geometry.srid(), mode: Geometry.mode() ]
Returns the WKB representation for a MultiPoint
.
With option :srid
an EWKB representation with the SRID is returned.
The option endian
indicates whether :xdr
big endian or :ndr
little
endian is returned. The default is :xdr
.
The :mode
determines whether a hex-string or binary is returned. The default
is :binary
.
An example of a simpler geometry can be found in the description for the
Geometry.Point.to_wkb/1
function.
Specs
to_wkt(t(), opts) :: Geometry.wkt() when opts: [{:srid, Geometry.srid()}]
Returns the WKT representation for a MultiPoint
. With option :srid
an
EWKT representation with the SRID is returned.
There are no guarantees about the order of points in the returned WKT-string.
Examples
MultiPoint.to_wkt(MultiPoint.new())
# => "MultiPoint EMPTY"
MultiPoint.to_wkt(
MultiPoint.new([
Point.new(7.1, 8.1),
Point.new(9.2, 5.2)
]
)
# => "MultiPoint (7.1 8.1, 9.2 5.2)"
MultiPoint.to_wkt(
MultiPoint.new([
Point.new(7.1, 8.1),
Point.new(9.2, 5.2)
]),
srid: 123
)
# => "SRID=123;MultiPoint (7.1 8.1, 9.2 5.2)"