jord-0.2.0.0: Geographical Position Calculations

Copyright	(c) 2018 Cedric Liegeois
License	BSD3
Maintainer	Cedric Liegeois <ofmooseandmen@yahoo.fr>
Stability	experimental
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Data.Geo.Jord.Length

Contents

The Length type
Smart constructors
Read
Conversions
Misc.

Description

Types and functions for working with (signed) lengths in metres, kilometres or nautical miles.

Synopsis

data Length
kilometres :: Double -> Length
metres :: Double -> Length
nauticalMiles :: Double -> Length
readLength :: String -> Length
readLengthE :: String -> Either String Length
readLengthF :: MonadFail m => String -> m Length
toKilometres :: Length -> Double
toMetres :: Length -> Double
toNauticalMiles :: Length -> Double
isZero :: Length -> Bool

The `Length` type

data Length Source #

A length with a resolution of 1 millimetre.

Instances

Eq Length Source #
Instance details Defined in Data.Geo.Jord.Length Methods (==) :: Length -> Length -> Bool # (/=) :: Length -> Length -> Bool #
Read Length Source #	See `readLength`.
Instance details Defined in Data.Geo.Jord.Length Methods readsPrec :: Int -> ReadS Length # readList :: ReadS [Length] # readPrec :: ReadPrec Length # readListPrec :: ReadPrec [Length] #
Show Length Source #	Length is shown in metres when <= 10,000 m and in kilometres otherwise.
Instance details Defined in Data.Geo.Jord.Length Methods showsPrec :: Int -> Length -> ShowS # show :: Length -> String # showList :: [Length] -> ShowS #
Quantity Length Source #	Add/Subtract Length.
Instance details Defined in Data.Geo.Jord.Length Methods add :: Length -> Length -> Length Source # sub :: Length -> Length -> Length Source #

Smart constructors

kilometres :: Double -> Length Source #

Length from given amount of kilometres.

metres :: Double -> Length Source #

Length from given amount of metres.

nauticalMiles :: Double -> Length Source #

Length from given amount of nautical miles.

Read

readLength :: String -> Length Source #

Obtains a Length from the given string formatted as (-)float[m|km|nm] - e.g. 3000m, 2.5km or -154nm.

This simply calls read s :: Length so error should be handled at the call site.

readLengthE :: String -> Either String Length Source #

Same as readLength but returns a Either.

readLengthF :: MonadFail m => String -> m Length Source #

Same as readLength but returns a MonadFail.

Conversions

toKilometres :: Length -> Double Source #

toKilometres l converts l to kilometres.

toMetres :: Length -> Double Source #

toMetres l converts l to metres.

toNauticalMiles :: Length -> Double Source #

toNauticalMiles l converts l to nautical miles.

Misc.

isZero :: Length -> Bool Source #

Is given Length == 0?