Copyright	(C) 2014-2018 HS-GeoJSON Project
License	BSD-style (see the file LICENSE.md)
Maintainer	Andrew Newman
Safe Haskell	None
Language	Haskell2010

Data.LineString

Contents

Type
Functions

Description

Refer to the GeoJSON Spec http://geojson.org/geojson-spec.html#linestring

A LinearString is a List with at least 2 elements

Synopsis

data LineString a
data ListToLineStringError
- = ListEmpty
- | SingletonList
fromLineString :: LineString a -> [a]
fromList :: Validate v => [a] -> v ListToLineStringError (LineString a)
makeLineString :: a -> a -> [a] -> LineString a
lineStringHead :: LineString a -> a
lineStringLast :: LineString a -> a
lineStringLength :: LineString a -> Int

Type

data LineString a Source #

a LineString has at least 2 elements

Instances

Functor LineString Source #
Instance details Defined in Data.LineString Methods fmap :: (a -> b) -> LineString a -> LineString b # (<$) :: a -> LineString b -> LineString a #
Foldable LineString Source #	This instance of Foldable will run through the entire ring, closing the loop by also passing the initial element in again at the end.
Instance details Defined in Data.LineString Methods fold :: Monoid m => LineString m -> m # foldMap :: Monoid m => (a -> m) -> LineString a -> m # foldr :: (a -> b -> b) -> b -> LineString a -> b # foldr' :: (a -> b -> b) -> b -> LineString a -> b # foldl :: (b -> a -> b) -> b -> LineString a -> b # foldl' :: (b -> a -> b) -> b -> LineString a -> b # foldr1 :: (a -> a -> a) -> LineString a -> a # foldl1 :: (a -> a -> a) -> LineString a -> a # toList :: LineString a -> [a] # null :: LineString a -> Bool # length :: LineString a -> Int # elem :: Eq a => a -> LineString a -> Bool # maximum :: Ord a => LineString a -> a # minimum :: Ord a => LineString a -> a # sum :: Num a => LineString a -> a # product :: Num a => LineString a -> a #
Traversable LineString Source #
Instance details Defined in Data.LineString Methods traverse :: Applicative f => (a -> f b) -> LineString a -> f (LineString b) # sequenceA :: Applicative f => LineString (f a) -> f (LineString a) # mapM :: Monad m => (a -> m b) -> LineString a -> m (LineString b) # sequence :: Monad m => LineString (m a) -> m (LineString a) #
Eq a => Eq (LineString a) Source #
Instance details Defined in Data.LineString Methods (==) :: LineString a -> LineString a -> Bool # (/=) :: LineString a -> LineString a -> Bool #
Show a => Show (LineString a) Source #
Instance details Defined in Data.LineString Methods showsPrec :: Int -> LineString a -> ShowS # show :: LineString a -> String # showList :: [LineString a] -> ShowS #
ToJSON a => ToJSON (LineString a) Source #
Instance details Defined in Data.LineString Methods toJSON :: LineString a -> Value # toEncoding :: LineString a -> Encoding # toJSONList :: [LineString a] -> Value # toEncodingList :: [LineString a] -> Encoding #
(FromJSON a, Show a) => FromJSON (LineString a) Source #
Instance details Defined in Data.LineString Methods parseJSON :: Value -> Parser (LineString a) # parseJSONList :: Value -> Parser [LineString a] #

data ListToLineStringError Source #

When converting a List to a LineString, here is a list of things that can go wrong:

The list was empty
The list only had one element

Constructors

ListEmpty
SingletonList

Instances

Eq ListToLineStringError Source #
Instance details Defined in Data.LineString Methods (==) :: ListToLineStringError -> ListToLineStringError -> Bool # (/=) :: ListToLineStringError -> ListToLineStringError -> Bool #
Show ListToLineStringError Source #
Instance details Defined in Data.LineString Methods showsPrec :: Int -> ListToLineStringError -> ShowS # show :: ListToLineStringError -> String # showList :: [ListToLineStringError] -> ShowS #

Functions

fromLineString :: LineString a -> [a] Source #

This function converts it into a list and appends the given element to the end.

fromList :: Validate v => [a] -> v ListToLineStringError (LineString a) Source #

creates a LineString out of a list of elements, if there are enough elements (needs at least 2) elements

makeLineString Source #

Arguments

:: a	The first element
-> a	The second element
-> [a]	The rest of the optional elements
-> LineString a

Creates a LineString makeLineString x y zs creates a LineString homomorphic to the list [x, y] ++ zs

lineStringHead :: LineString a -> a Source #

returns the element at the head of the string

lineStringLast :: LineString a -> a Source #

returns the last element in the string

lineStringLength :: LineString a -> Int Source #

returns the number of elements in the list, including the replicated element at the end of the list.