License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Language.Direction

Contents

Directions

Description

Types and helper functions for working with directions

Synopsis

data Direction
- = DAbsolute AbsoluteDir
- | DRelative RelativeDir
data AbsoluteDir
- = DEast
- | DNorth
- | DWest
- | DSouth
data RelativeDir
- = DPlanar PlanarRelativeDir
- | DDown
data PlanarRelativeDir
- = DForward
- | DLeft
- | DBack
- | DRight
directionSyntax :: Direction -> Text
isCardinal :: Direction -> Bool
allDirs :: [Direction]

Directions

data Direction Source #

The type of directions. Used e.g. to indicate which way a robot will turn.

Constructors

DAbsolute AbsoluteDir
DRelative RelativeDir

Instances

Instances details

FromJSON Direction Source #
Instance details Defined in Swarm.Language.Direction Methods parseJSON :: Value -> Parser Direction # parseJSONList :: Value -> Parser [Direction] #
ToJSON Direction Source #
Instance details Defined in Swarm.Language.Direction Methods toJSON :: Direction -> Value # toEncoding :: Direction -> Encoding # toJSONList :: [Direction] -> Value # toEncodingList :: [Direction] -> Encoding #
Data Direction Source #
Instance details Defined in Swarm.Language.Direction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Direction -> c Direction # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Direction # toConstr :: Direction -> Constr # dataTypeOf :: Direction -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Direction) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Direction) # gmapT :: (forall b. Data b => b -> b) -> Direction -> Direction # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r # gmapQ :: (forall d. Data d => d -> u) -> Direction -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Direction -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Direction -> m Direction # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction #
Generic Direction Source #
Instance details Defined in Swarm.Language.Direction Associated Types type Rep Direction :: Type -> Type # Methods from :: Direction -> Rep Direction x # to :: Rep Direction x -> Direction #
Read Direction Source #
Instance details Defined in Swarm.Language.Direction Methods readsPrec :: Int -> ReadS Direction # readList :: ReadS [Direction] # readPrec :: ReadPrec Direction # readListPrec :: ReadPrec [Direction] #
Show Direction Source #
Instance details Defined in Swarm.Language.Direction Methods showsPrec :: Int -> Direction -> ShowS # show :: Direction -> String # showList :: [Direction] -> ShowS #
Eq Direction Source #
Instance details Defined in Swarm.Language.Direction Methods (==) :: Direction -> Direction -> Bool # (/=) :: Direction -> Direction -> Bool #
Ord Direction Source #
Instance details Defined in Swarm.Language.Direction Methods compare :: Direction -> Direction -> Ordering # (<) :: Direction -> Direction -> Bool # (<=) :: Direction -> Direction -> Bool # (>) :: Direction -> Direction -> Bool # (>=) :: Direction -> Direction -> Bool # max :: Direction -> Direction -> Direction # min :: Direction -> Direction -> Direction #
Hashable Direction Source #
Instance details Defined in Swarm.Language.Direction Methods hashWithSalt :: Int -> Direction -> Int # hash :: Direction -> Int #
Valuable Direction Source #
Instance details Defined in Swarm.Game.Value Methods asValue :: Direction -> Value Source #
PrettyPrec Direction Source #
Instance details Defined in Swarm.Language.Pretty Methods prettyPrec :: Int -> Direction -> Doc ann Source #
type Rep Direction Source #
Instance details Defined in Swarm.Language.Direction type Rep Direction = D1 ('MetaData "Direction" "Swarm.Language.Direction" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "DAbsolute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AbsoluteDir)) :+: C1 ('MetaCons "DRelative" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelativeDir)))

data AbsoluteDir Source #

An absolute direction is one which is defined with respect to an external frame of reference; robots need a compass in order to use them.

NOTE: These values are ordered by increasing angle according to the standard mathematical convention. That is, the right-pointing direction, East, is considered the "reference angle" and the order proceeds counter-clockwise. See https://en.wikipedia.org/wiki/Polar_coordinate_system#Conventions

Do not alter this ordering, as there exist functions that depend on it (e.g. nearestDirection and relativeTo).

Constructors

DEast
DNorth
DWest
DSouth

Instances

Instances details

FromJSON AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods parseJSON :: Value -> Parser AbsoluteDir # parseJSONList :: Value -> Parser [AbsoluteDir] #
FromJSONKey AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods fromJSONKey :: FromJSONKeyFunction AbsoluteDir # fromJSONKeyList :: FromJSONKeyFunction [AbsoluteDir] #
ToJSON AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods toJSON :: AbsoluteDir -> Value # toEncoding :: AbsoluteDir -> Encoding # toJSONList :: [AbsoluteDir] -> Value # toEncodingList :: [AbsoluteDir] -> Encoding #
ToJSONKey AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods toJSONKey :: ToJSONKeyFunction AbsoluteDir # toJSONKeyList :: ToJSONKeyFunction [AbsoluteDir] #
Data AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AbsoluteDir -> c AbsoluteDir # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AbsoluteDir # toConstr :: AbsoluteDir -> Constr # dataTypeOf :: AbsoluteDir -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AbsoluteDir) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AbsoluteDir) # gmapT :: (forall b. Data b => b -> b) -> AbsoluteDir -> AbsoluteDir # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AbsoluteDir -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AbsoluteDir -> r # gmapQ :: (forall d. Data d => d -> u) -> AbsoluteDir -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AbsoluteDir -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AbsoluteDir -> m AbsoluteDir # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AbsoluteDir -> m AbsoluteDir # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AbsoluteDir -> m AbsoluteDir #
Bounded AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods minBound :: AbsoluteDir # maxBound :: AbsoluteDir #
Enum AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods succ :: AbsoluteDir -> AbsoluteDir # pred :: AbsoluteDir -> AbsoluteDir # toEnum :: Int -> AbsoluteDir # fromEnum :: AbsoluteDir -> Int # enumFrom :: AbsoluteDir -> [AbsoluteDir] # enumFromThen :: AbsoluteDir -> AbsoluteDir -> [AbsoluteDir] # enumFromTo :: AbsoluteDir -> AbsoluteDir -> [AbsoluteDir] # enumFromThenTo :: AbsoluteDir -> AbsoluteDir -> AbsoluteDir -> [AbsoluteDir] #
Generic AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Associated Types type Rep AbsoluteDir :: Type -> Type # Methods from :: AbsoluteDir -> Rep AbsoluteDir x # to :: Rep AbsoluteDir x -> AbsoluteDir #
Read AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods readsPrec :: Int -> ReadS AbsoluteDir # readList :: ReadS [AbsoluteDir] # readPrec :: ReadPrec AbsoluteDir # readListPrec :: ReadPrec [AbsoluteDir] #
Show AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods showsPrec :: Int -> AbsoluteDir -> ShowS # show :: AbsoluteDir -> String # showList :: [AbsoluteDir] -> ShowS #
Eq AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods (==) :: AbsoluteDir -> AbsoluteDir -> Bool # (/=) :: AbsoluteDir -> AbsoluteDir -> Bool #
Ord AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods compare :: AbsoluteDir -> AbsoluteDir -> Ordering # (<) :: AbsoluteDir -> AbsoluteDir -> Bool # (<=) :: AbsoluteDir -> AbsoluteDir -> Bool # (>) :: AbsoluteDir -> AbsoluteDir -> Bool # (>=) :: AbsoluteDir -> AbsoluteDir -> Bool # max :: AbsoluteDir -> AbsoluteDir -> AbsoluteDir # min :: AbsoluteDir -> AbsoluteDir -> AbsoluteDir #
Hashable AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction Methods hashWithSalt :: Int -> AbsoluteDir -> Int # hash :: AbsoluteDir -> Int #
type Rep AbsoluteDir Source #
Instance details Defined in Swarm.Language.Direction type Rep AbsoluteDir = D1 ('MetaData "AbsoluteDir" "Swarm.Language.Direction" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) ((C1 ('MetaCons "DEast" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DNorth" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DWest" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DSouth" 'PrefixI 'False) (U1 :: Type -> Type)))

data RelativeDir Source #

A relative direction is one which is defined with respect to the robot's frame of reference; no special capability is needed to use them.

Constructors

DPlanar PlanarRelativeDir
DDown

Instances

Instances details

FromJSON RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods parseJSON :: Value -> Parser RelativeDir # parseJSONList :: Value -> Parser [RelativeDir] #
ToJSON RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods toJSON :: RelativeDir -> Value # toEncoding :: RelativeDir -> Encoding # toJSONList :: [RelativeDir] -> Value # toEncodingList :: [RelativeDir] -> Encoding #
Data RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RelativeDir -> c RelativeDir # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RelativeDir # toConstr :: RelativeDir -> Constr # dataTypeOf :: RelativeDir -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RelativeDir) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RelativeDir) # gmapT :: (forall b. Data b => b -> b) -> RelativeDir -> RelativeDir # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RelativeDir -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RelativeDir -> r # gmapQ :: (forall d. Data d => d -> u) -> RelativeDir -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RelativeDir -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RelativeDir -> m RelativeDir # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RelativeDir -> m RelativeDir # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RelativeDir -> m RelativeDir #
Generic RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Associated Types type Rep RelativeDir :: Type -> Type # Methods from :: RelativeDir -> Rep RelativeDir x # to :: Rep RelativeDir x -> RelativeDir #
Read RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods readsPrec :: Int -> ReadS RelativeDir # readList :: ReadS [RelativeDir] # readPrec :: ReadPrec RelativeDir # readListPrec :: ReadPrec [RelativeDir] #
Show RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods showsPrec :: Int -> RelativeDir -> ShowS # show :: RelativeDir -> String # showList :: [RelativeDir] -> ShowS #
Eq RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods (==) :: RelativeDir -> RelativeDir -> Bool # (/=) :: RelativeDir -> RelativeDir -> Bool #
Ord RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods compare :: RelativeDir -> RelativeDir -> Ordering # (<) :: RelativeDir -> RelativeDir -> Bool # (<=) :: RelativeDir -> RelativeDir -> Bool # (>) :: RelativeDir -> RelativeDir -> Bool # (>=) :: RelativeDir -> RelativeDir -> Bool # max :: RelativeDir -> RelativeDir -> RelativeDir # min :: RelativeDir -> RelativeDir -> RelativeDir #
Hashable RelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods hashWithSalt :: Int -> RelativeDir -> Int # hash :: RelativeDir -> Int #
type Rep RelativeDir Source #
Instance details Defined in Swarm.Language.Direction type Rep RelativeDir = D1 ('MetaData "RelativeDir" "Swarm.Language.Direction" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "DPlanar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlanarRelativeDir)) :+: C1 ('MetaCons "DDown" 'PrefixI 'False) (U1 :: Type -> Type))

data PlanarRelativeDir Source #

Caution: Do not alter this ordering, as there exist functions that depend on it (e.g. nearestDirection and relativeTo).

Constructors

DForward
DLeft
DBack
DRight

Instances

Instances details

FromJSON PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods parseJSON :: Value -> Parser PlanarRelativeDir # parseJSONList :: Value -> Parser [PlanarRelativeDir] #
ToJSON PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods toJSON :: PlanarRelativeDir -> Value # toEncoding :: PlanarRelativeDir -> Encoding # toJSONList :: [PlanarRelativeDir] -> Value # toEncodingList :: [PlanarRelativeDir] -> Encoding #
Data PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlanarRelativeDir -> c PlanarRelativeDir # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlanarRelativeDir # toConstr :: PlanarRelativeDir -> Constr # dataTypeOf :: PlanarRelativeDir -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PlanarRelativeDir) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlanarRelativeDir) # gmapT :: (forall b. Data b => b -> b) -> PlanarRelativeDir -> PlanarRelativeDir # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlanarRelativeDir -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlanarRelativeDir -> r # gmapQ :: (forall d. Data d => d -> u) -> PlanarRelativeDir -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PlanarRelativeDir -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlanarRelativeDir -> m PlanarRelativeDir # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlanarRelativeDir -> m PlanarRelativeDir # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlanarRelativeDir -> m PlanarRelativeDir #
Bounded PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods minBound :: PlanarRelativeDir # maxBound :: PlanarRelativeDir #
Enum PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods succ :: PlanarRelativeDir -> PlanarRelativeDir # pred :: PlanarRelativeDir -> PlanarRelativeDir # toEnum :: Int -> PlanarRelativeDir # fromEnum :: PlanarRelativeDir -> Int # enumFrom :: PlanarRelativeDir -> [PlanarRelativeDir] # enumFromThen :: PlanarRelativeDir -> PlanarRelativeDir -> [PlanarRelativeDir] # enumFromTo :: PlanarRelativeDir -> PlanarRelativeDir -> [PlanarRelativeDir] # enumFromThenTo :: PlanarRelativeDir -> PlanarRelativeDir -> PlanarRelativeDir -> [PlanarRelativeDir] #
Generic PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Associated Types type Rep PlanarRelativeDir :: Type -> Type # Methods from :: PlanarRelativeDir -> Rep PlanarRelativeDir x # to :: Rep PlanarRelativeDir x -> PlanarRelativeDir #
Read PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods readsPrec :: Int -> ReadS PlanarRelativeDir # readList :: ReadS [PlanarRelativeDir] # readPrec :: ReadPrec PlanarRelativeDir # readListPrec :: ReadPrec [PlanarRelativeDir] #
Show PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods showsPrec :: Int -> PlanarRelativeDir -> ShowS # show :: PlanarRelativeDir -> String # showList :: [PlanarRelativeDir] -> ShowS #
Eq PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods (==) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool # (/=) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool #
Ord PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods compare :: PlanarRelativeDir -> PlanarRelativeDir -> Ordering # (<) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool # (<=) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool # (>) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool # (>=) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool # max :: PlanarRelativeDir -> PlanarRelativeDir -> PlanarRelativeDir # min :: PlanarRelativeDir -> PlanarRelativeDir -> PlanarRelativeDir #
Hashable PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction Methods hashWithSalt :: Int -> PlanarRelativeDir -> Int # hash :: PlanarRelativeDir -> Int #
type Rep PlanarRelativeDir Source #
Instance details Defined in Swarm.Language.Direction type Rep PlanarRelativeDir = D1 ('MetaData "PlanarRelativeDir" "Swarm.Language.Direction" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) ((C1 ('MetaCons "DForward" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DLeft" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DBack" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DRight" 'PrefixI 'False) (U1 :: Type -> Type)))

directionSyntax :: Direction -> Text Source #

Direction name is generated from the deepest nested data constructor e.g. DLeft becomes "left"

isCardinal :: Direction -> Bool Source #

Check if the direction is absolute (e.g. north or south).

allDirs :: [Direction] Source #