Swarm.Language.Direction

Types and helper functions for working with directions

Directions

data Direction

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

Constructors

DAbsolute AbsoluteDir

DRelative RelativeDir

Instances

FromJSON Direction

Defined in Swarm.Language.Direction

Methods

parseJSON :: Value -> Parser Direction

parseJSONList :: Value -> Parser [Direction]

ToJSON Direction

Defined in Swarm.Language.Direction

Methods

toJSON :: Direction -> Value

toEncoding :: Direction -> Encoding

toJSONList :: [Direction] -> Value

toEncodingList :: [Direction] -> Encoding

Data Direction

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

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

Defined in Swarm.Language.Direction

Methods

readsPrec :: Int -> ReadS Direction

readList :: ReadS [Direction]

readPrec :: ReadPrec Direction

readListPrec :: ReadPrec [Direction]

Show Direction

Defined in Swarm.Language.Direction

Methods

showsPrec :: Int -> Direction -> ShowS

show :: Direction -> String

showList :: [Direction] -> ShowS

Eq Direction

Defined in Swarm.Language.Direction

Methods

(==) :: Direction -> Direction -> Bool

(/=) :: Direction -> Direction -> Bool

Ord Direction

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

Defined in Swarm.Language.Direction

Methods

hashWithSalt :: Int -> Direction -> Int

hash :: Direction -> Int

Valuable Direction

Defined in Swarm.Game.Value

Methods

asValue :: Direction -> Value

PrettyPrec Direction

Defined in Swarm.Language.Pretty

Methods

prettyPrec :: Int -> Direction -> Doc ann

type Rep Direction

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

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

FromJSON AbsoluteDir

Defined in Swarm.Language.Direction

Methods

parseJSON :: Value -> Parser AbsoluteDir

parseJSONList :: Value -> Parser [AbsoluteDir]

FromJSONKey AbsoluteDir

Defined in Swarm.Language.Direction

Methods

fromJSONKey :: FromJSONKeyFunction AbsoluteDir

fromJSONKeyList :: FromJSONKeyFunction [AbsoluteDir]

ToJSON AbsoluteDir

Defined in Swarm.Language.Direction

Methods

toJSON :: AbsoluteDir -> Value

toEncoding :: AbsoluteDir -> Encoding

toJSONList :: [AbsoluteDir] -> Value

toEncodingList :: [AbsoluteDir] -> Encoding

ToJSONKey AbsoluteDir

Defined in Swarm.Language.Direction

Methods

toJSONKey :: ToJSONKeyFunction AbsoluteDir

toJSONKeyList :: ToJSONKeyFunction [AbsoluteDir]

Data AbsoluteDir

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

Defined in Swarm.Language.Direction

Methods

minBound :: AbsoluteDir

maxBound :: AbsoluteDir

Enum AbsoluteDir

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

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

Defined in Swarm.Language.Direction

Methods

readsPrec :: Int -> ReadS AbsoluteDir

readList :: ReadS [AbsoluteDir]

readPrec :: ReadPrec AbsoluteDir

readListPrec :: ReadPrec [AbsoluteDir]

Show AbsoluteDir

Defined in Swarm.Language.Direction

Methods

showsPrec :: Int -> AbsoluteDir -> ShowS

show :: AbsoluteDir -> String

showList :: [AbsoluteDir] -> ShowS

Eq AbsoluteDir

Defined in Swarm.Language.Direction

Methods

(==) :: AbsoluteDir -> AbsoluteDir -> Bool

(/=) :: AbsoluteDir -> AbsoluteDir -> Bool

Ord AbsoluteDir

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

Defined in Swarm.Language.Direction

Methods

hashWithSalt :: Int -> AbsoluteDir -> Int

hash :: AbsoluteDir -> Int

type Rep AbsoluteDir

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

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

FromJSON RelativeDir

Defined in Swarm.Language.Direction

Methods

parseJSON :: Value -> Parser RelativeDir

parseJSONList :: Value -> Parser [RelativeDir]

ToJSON RelativeDir

Defined in Swarm.Language.Direction

Methods

toJSON :: RelativeDir -> Value

toEncoding :: RelativeDir -> Encoding

toJSONList :: [RelativeDir] -> Value

toEncodingList :: [RelativeDir] -> Encoding

Data RelativeDir

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

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

Defined in Swarm.Language.Direction

Methods

readsPrec :: Int -> ReadS RelativeDir

readList :: ReadS [RelativeDir]

readPrec :: ReadPrec RelativeDir

readListPrec :: ReadPrec [RelativeDir]

Show RelativeDir

Defined in Swarm.Language.Direction

Methods

showsPrec :: Int -> RelativeDir -> ShowS

show :: RelativeDir -> String

showList :: [RelativeDir] -> ShowS

Eq RelativeDir

Defined in Swarm.Language.Direction

Methods

(==) :: RelativeDir -> RelativeDir -> Bool

(/=) :: RelativeDir -> RelativeDir -> Bool

Ord RelativeDir

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

Defined in Swarm.Language.Direction

Methods

hashWithSalt :: Int -> RelativeDir -> Int

hash :: RelativeDir -> Int

type Rep RelativeDir

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

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

FromJSON PlanarRelativeDir

Defined in Swarm.Language.Direction

Methods

parseJSON :: Value -> Parser PlanarRelativeDir

parseJSONList :: Value -> Parser [PlanarRelativeDir]

ToJSON PlanarRelativeDir

Defined in Swarm.Language.Direction

Methods

toJSON :: PlanarRelativeDir -> Value

toEncoding :: PlanarRelativeDir -> Encoding

toJSONList :: [PlanarRelativeDir] -> Value

toEncodingList :: [PlanarRelativeDir] -> Encoding

Data PlanarRelativeDir

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

Defined in Swarm.Language.Direction

Methods

minBound :: PlanarRelativeDir

maxBound :: PlanarRelativeDir

Enum PlanarRelativeDir

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

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

Defined in Swarm.Language.Direction

Methods

readsPrec :: Int -> ReadS PlanarRelativeDir

readList :: ReadS [PlanarRelativeDir]

readPrec :: ReadPrec PlanarRelativeDir

readListPrec :: ReadPrec [PlanarRelativeDir]

Show PlanarRelativeDir

Defined in Swarm.Language.Direction

Methods

showsPrec :: Int -> PlanarRelativeDir -> ShowS

show :: PlanarRelativeDir -> String

showList :: [PlanarRelativeDir] -> ShowS

Eq PlanarRelativeDir

Defined in Swarm.Language.Direction

Methods

(==) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool

(/=) :: PlanarRelativeDir -> PlanarRelativeDir -> Bool

Ord PlanarRelativeDir

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

Defined in Swarm.Language.Direction

Methods

hashWithSalt :: Int -> PlanarRelativeDir -> Int

hash :: PlanarRelativeDir -> Int

type Rep PlanarRelativeDir

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

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

isCardinal :: Direction -> Bool

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

allDirs :: [Direction]