Specs

empty?(t()) :: boolean()

Returns true if the given MultiPointM is empty.

Examples

iex> MultiPointM.empty?(MultiPointM.new())
true

iex> MultiPointM.empty?(
...>   MultiPointM.new(
...>     [PointM.new(1, 2, 4), PointM.new(3, 4, 6)]
...>   )
...> )
false

Specs

from_coordinates([Geometry.coordinate()]) :: t()

Creates a MultiPointM from the given coordinates.

Examples

iex> MultiPointM.from_coordinates(
...>   [[-1, 1, 1], [-2, 2, 2], [-3, 3, 3]]
...> )
%MultiPointM{
  points: MapSet.new([
    [-1, 1, 1],
    [-2, 2, 2],
    [-3, 3, 3]
  ])
}

iex> MultiPointM.from_coordinates(
...>   [[-1, 1, 1], [-2, 2, 2], [-3, 3, 3]]
...> )
%MultiPointM{
  points: MapSet.new([
    [-1, 1, 1],
    [-2, 2, 2],
    [-3, 3, 3]
  ])
}

Specs

from_geo_json(Geometry.geo_json_term()) ::
  {:ok, t()} | Geometry.geo_json_error()

Returns an :ok tuple with the MultiPointM from the given GeoJSON term. Otherwise returns an :error tuple.

Examples

iex> ~s(
...>   {
...>     "type": "MultiPoint",
...>     "coordinates": [
...>       [1.1, 1.2, 1.4],
...>       [20.1, 20.2, 20.4]
...>     ]
...>   }
...> )
iex> |> Jason.decode!()
iex> |> MultiPointM.from_geo_json()
{:ok, %MultiPointM{points: MapSet.new([
  [1.1, 1.2, 1.4],
  [20.1, 20.2, 20.4]
])}}

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 MultiPointM 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.PointM.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 MultiPointM 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> MultiPointM.from_wkt(
...>   "MultiPoint M (-5.1 7.8 1, 0.1 0.2 2)"
...> )
{:ok, %MultiPointM{
  points: MapSet.new([
    [-5.1, 7.8, 1],
    [0.1, 0.2, 2]
  ])
}}

iex> MultiPointM.from_wkt(
...>   "SRID=7219;MultiPoint M (-5.1 7.8 1, 0.1 0.2 2)"
...> )
{:ok, {
  %MultiPointM{
    points: MapSet.new([
      [-5.1, 7.8, 1],
      [0.1, 0.2, 2]
    ])
  },
  7219
}}

iex> MultiPointM.from_wkt("MultiPoint M EMPTY")
...> {:ok, %MultiPointM{}}

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.PointM.t()) :: boolean()

Checks if MulitPointM contains point.

Examples

iex> MultiPointM.member?(
...>   MultiPointM.new([
...>     PointM.new(11, 12, 14),
...>     PointM.new(21, 22, 24)
...>   ]),
...>   PointM.new(11, 12, 14)
...> )
true

iex> MultiPointM.member?(
...>   MultiPointM.new([
...>     PointM.new(11, 12, 14),
...>     PointM.new(21, 22, 24)
...>   ]),
...>   PointM.new(1, 2, 4)
...> )
false

Specs

new() :: t()

Creates an empty MultiPointM.

Examples

iex> MultiPointM.new()
%MultiPointM{points: MapSet.new()}

Specs

new([Geometry.PointM.t()]) :: t()

Creates a MultiPointM from the given Geometry.PointMs.

Examples

iex> MultiPointM.new([
...>   PointM.new(1, 2, 4),
...>   PointM.new(1, 2, 4),
...>   PointM.new(3, 4, 6)
...> ])
%MultiPointM{points: MapSet.new([
  [1, 2, 4],
  [3, 4, 6]
])}

iex> MultiPointM.new([])
%MultiPointM{points: MapSet.new()}

Specs

size(t()) :: non_neg_integer()

Returns the number of elements in MultiPointM.

Examples

iex> MultiPointM.size(
...>   MultiPointM.new([
...>     PointM.new(11, 12, 14),
...>     PointM.new(21, 22, 24)
...>   ])
...> )
2

Specs

to_geo_json(t()) :: Geometry.geo_json_term()

Returns the GeoJSON term of a MultiPointM.

There are no guarantees about the order of points in the returned coordinates.

Examples

MultiPointM.to_geo_json(
  MultiPointM.new([
    PointM.new(-1.1, -2.2, -4.4),
    PointM.new(1.1, 2.2, 4.4)
  ])
)
# =>
# %{
#   "type" => "MultiPoint",
#   "coordinates" => [
#     [-1.1, -2.2, -4.4],
#     [1.1, 2.2, 4.4]
#   ]
# }

Specs

to_list(t()) :: [Geometry.PointM.t()]

Converts MultiPointM to a list.

Examples

iex> MultiPointM.to_list(
...>   MultiPointM.new([
...>     PointM.new(11, 12, 14),
...>     PointM.new(21, 22, 24)
...>   ])
...> )
[
  [11, 12, 14],
  [21, 22, 24]
]

Specs

to_wkb(t(), opts) :: Geometry.wkb()
when opts: [
       endian: Geometry.endian(),
       srid: Geometry.srid(),
       mode: Geometry.mode()
     ]

Returns the WKB representation for a MultiPointM.

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.PointM.to_wkb/1 function.

Specs

to_wkt(t(), opts) :: Geometry.wkt() when opts: [{:srid, Geometry.srid()}]

Returns the WKT representation for a MultiPointM. 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

MultiPointM.to_wkt(MultiPointM.new())
# => "MultiPoint M EMPTY"

MultiPointM.to_wkt(
  MultiPointM.new([
    PointM.new(7.1, 8.1, 1),
    PointM.new(9.2, 5.2, 2)
  ]
)
# => "MultiPoint M (7.1 8.1 1, 9.2 5.2 2)"

MultiPointM.to_wkt(
  MultiPointM.new([
    PointM.new(7.1, 8.1, 1),
    PointM.new(9.2, 5.2, 2)
  ]),
  srid: 123
)
# => "SRID=123;MultiPoint M (7.1 8.1 1, 9.2 5.2 2)"