@spec empty?(t()) :: boolean()

Returns true if the given LineString is empty.

examples

Examples

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

iex> LineString.empty?(
...>   LineString.new(
...>     [Point.new(1, 2), Point.new(3, 4)]
...>   )
...> )
false

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

Creates a LineString from the given coordinates.

examples

Examples

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

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

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

examples

Examples

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

@spec from_geo_json!(Geometry.geo_json_term()) :: t()

The same as from_geo_json/1, but raises a Geometry.Error exception if it fails.

@spec from_wkb(Geometry.wkb(), Geometry.mode()) ::
  {:ok, t() | {t(), Geometry.srid()}} | Geometry.wkb_error()

Returns an :ok tuple with the LineString from the given WKB string. Otherwise returns an :error tuple.

If the geometry contains a SRID the id is added to the tuple.

The optional second argument determines if a :hex-string or a :binary input is expected. The default is :binary.

An example of a simpler geometry can be found in the description for the Geometry.Point.from_wkb/2 function.

@spec 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.

@spec from_wkt(Geometry.wkt()) ::
  {:ok, t()} | {:ok, t(), Geometry.srid()} | Geometry.wkt_error()

Returns an :ok tuple with the LineString from the given WKT string. Otherwise returns an :error tuple.

If the geometry contains a SRID the id is added to the tuple.

examples

Examples

iex> LineString.from_wkt(
...>   "LineString (-5.1 7.8, 0.1 0.2)"
...> )
{:ok, %LineString{
  points: [
    [-5.1, 7.8],
    [0.1, 0.2]
  ]
}}

iex> LineString.from_wkt(
...>   "SRID=7219;LineString (-5.1 7.8, 0.1 0.2)"
...> )
{:ok, {
  %LineString{
    points: [
      [-5.1, 7.8],
      [0.1, 0.2]
    ]
  },
  7219
}}

iex> LineString.from_wkt("LineString EMPTY")
{:ok, %LineString{}}

@spec from_wkt!(Geometry.wkt()) :: t() | {t(), Geometry.srid()}

The same as from_wkt/1, but raises a Geometry.Error exception if it fails.

@spec new() :: t()

Creates an empty LineString.

examples

Examples

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

@spec new([Geometry.Point.t()]) :: t()

Creates a LineString from the given Geometry.Points.

examples

Examples

iex> LineString.new([Point.new(1, 2), Point.new(3, 4)])
%LineString{points: [[1, 2], [3, 4]]}

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

Returns the GeoJSON term of a LineString.

examples

Examples

iex> LineString.to_geo_json(
...>   LineString.new([
...>     Point.new(-1.1, -2.2),
...>     Point.new(1.1, 2.2)
...>   ])
...> )
%{
  "type" => "LineString",
  "coordinates" => [
    [-1.1, -2.2],
    [1.1, 2.2]
  ]
}

@spec to_wkb(line_string, opts) :: wkb
when line_string: t() | Geometry.coordinates(),
     opts: [
       endian: Geometry.endian(),
       srid: Geometry.srid(),
       mode: Geometry.mode()
     ],
     wkb: Geometry.wkb()

Returns the WKB representation for a LineString.

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.

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

Returns the WKT representation for a LineString. With option :srid an EWKT representation with the SRID is returned.

examples

Examples

iex> LineString.to_wkt(LineString.new())
"LineString EMPTY"

iex> LineString.to_wkt(
...>   LineString.new([
...>     Point.new(7.1, 8.1),
...>     Point.new(9.2, 5.2)
...>   ])
...> )
"LineString (7.1 8.1, 9.2 5.2)"

iex> LineString.to_wkt(
...>   LineString.new([
...>     Point.new(7.1, 8.1),
...>     Point.new(9.2, 5.2)
...>   ]),
...>   srid: 123
...> )
"SRID=123;LineString (7.1 8.1, 9.2 5.2)"