Copyright	(c) Grant Weyburne 2022
License	BSD-3
Safe Haskell	None
Language	Haskell2010

Cybus.Fin

Contents

Description

used for single indexes into a Mat or FinMat

Synopsis

data Fin n
fnPos :: Fin n -> Pos
fnN :: Fin n -> Pos
pattern Fin :: forall (n :: Nat). Pos -> Pos -> Fin n
pattern FinU :: forall (n :: Nat). (HasCallStack, PosT n) => Pos -> Pos -> Fin n
type FinT i n = (i <=! n, PosT n)
type FinWithMessageT msg i n = (LTEQT msg i n, PosT n)
finC :: forall (i :: Nat) (n :: Nat). FinT i n => Fin n
showFin :: Fin n -> String
readFinP :: forall n. PosT n => ReadP (Fin n)
readFin :: PosT n => ReadS (Fin n)
mkFinC :: forall n. PosT n => Pos -> Pos -> Either String (Fin n)
mkFin :: Pos -> Pos -> Either String (Fin n)
fin :: PosT n => Int -> Either String (Fin n)
finP :: forall n. PosT n => Pos -> Either String (Fin n)
_F1 :: FinT 1 n => Fin n
_F2 :: FinT 2 n => Fin n
_F3 :: FinT 3 n => Fin n
_F4 :: FinT 4 n => Fin n
_F5 :: FinT 5 n => Fin n
_F6 :: FinT 6 n => Fin n
_F7 :: FinT 7 n => Fin n
_F8 :: FinT 8 n => Fin n
_F9 :: FinT 9 n => Fin n
_F10 :: FinT 10 n => Fin n
_F11 :: FinT 11 n => Fin n
_F12 :: FinT 12 n => Fin n
_F13 :: FinT 13 n => Fin n
_F14 :: FinT 14 n => Fin n
_F15 :: FinT 15 n => Fin n
_F16 :: FinT 16 n => Fin n
_F17 :: FinT 17 n => Fin n
_F18 :: FinT 18 n => Fin n
_F19 :: FinT 19 n => Fin n
_F20 :: FinT 20 n => Fin n

Documentation

data Fin n Source #

definition of the Finite type

Instances

Instances details

Generic1 Fin Source #
Instance details Defined in Cybus.Fin Associated Types type Rep1 Fin :: k -> Type # Methods from1 :: forall (a :: k). Fin a -> Rep1 Fin a # to1 :: forall (a :: k). Rep1 Fin a -> Fin a #
PosT n => Bounded (Fin n) Source #
Instance details Defined in Cybus.Fin Methods minBound :: Fin n # maxBound :: Fin n #
PosT n => Enum (Fin n) Source #
Instance details Defined in Cybus.Fin Methods succ :: Fin n -> Fin n # pred :: Fin n -> Fin n # toEnum :: Int -> Fin n # fromEnum :: Fin n -> Int # enumFrom :: Fin n -> [Fin n] # enumFromThen :: Fin n -> Fin n -> [Fin n] # enumFromTo :: Fin n -> Fin n -> [Fin n] # enumFromThenTo :: Fin n -> Fin n -> Fin n -> [Fin n] #
Eq (Fin n) Source #
Instance details Defined in Cybus.Fin Methods (==) :: Fin n -> Fin n -> Bool # (/=) :: Fin n -> Fin n -> Bool #
PosT n => Num (Fin n) Source #
Instance details Defined in Cybus.Fin Methods (+) :: Fin n -> Fin n -> Fin n # (-) :: Fin n -> Fin n -> Fin n # (*) :: Fin n -> Fin n -> Fin n # negate :: Fin n -> Fin n # abs :: Fin n -> Fin n # signum :: Fin n -> Fin n # fromInteger :: Integer -> Fin n #
Ord (Fin n) Source #
Instance details Defined in Cybus.Fin Methods compare :: Fin n -> Fin n -> Ordering # (<) :: Fin n -> Fin n -> Bool # (<=) :: Fin n -> Fin n -> Bool # (>) :: Fin n -> Fin n -> Bool # (>=) :: Fin n -> Fin n -> Bool # max :: Fin n -> Fin n -> Fin n # min :: Fin n -> Fin n -> Fin n #
PosT n => Read (Fin n) Source #
Instance details Defined in Cybus.Fin Methods readsPrec :: Int -> ReadS (Fin n) # readList :: ReadS [Fin n] # readPrec :: ReadPrec (Fin n) # readListPrec :: ReadPrec [Fin n] #
Show (Fin n) Source #
Instance details Defined in Cybus.Fin Methods showsPrec :: Int -> Fin n -> ShowS # show :: Fin n -> String # showList :: [Fin n] -> ShowS #
Generic (Fin n) Source #
Instance details Defined in Cybus.Fin Associated Types type Rep (Fin n) :: Type -> Type # Methods from :: Fin n -> Rep (Fin n) x # to :: Rep (Fin n) x -> Fin n #
Semigroup (Fin n) Source #
Instance details Defined in Cybus.Fin Methods (<>) :: Fin n -> Fin n -> Fin n # sconcat :: NonEmpty (Fin n) -> Fin n # stimes :: Integral b => b -> Fin n -> Fin n #
PosT n => Monoid (Fin n) Source #
Instance details Defined in Cybus.Fin Methods mempty :: Fin n # mappend :: Fin n -> Fin n -> Fin n # mconcat :: [Fin n] -> Fin n #
NFData (Fin n) Source #
Instance details Defined in Cybus.Fin Methods rnf :: Fin n -> () #
PosT n => Num1 (Fin n) Source #
Instance details Defined in Cybus.Fin Methods toInteger1 :: Fin n -> Integer # fromInteger1 :: Fin n -> Integer -> Either String (Fin n) # (.+) :: Either String (Fin n) -> Either String (Fin n) -> Either String (Fin n) # (.-) :: Either String (Fin n) -> Either String (Fin n) -> Either String (Fin n) # (.*) :: Either String (Fin n) -> Either String (Fin n) -> Either String (Fin n) # negate1 :: Either String (Fin n) -> Either String (Fin n) # abs1 :: Either String (Fin n) -> Either String (Fin n) # signum1 :: Either String (Fin n) -> Either String (Fin n) # succ1 :: Either String (Fin n) -> Either String (Fin n) # pred1 :: Either String (Fin n) -> Either String (Fin n) #
type Rep1 Fin Source #
Instance details Defined in Cybus.Fin type Rep1 Fin = D1 ('MetaData "Fin" "Cybus.Fin" "cybus-0.2.0.0-5MGnPC0rvDP5BLNjb43WK9" 'False) (C1 ('MetaCons "Fin'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pos) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pos)))
type Rep (Fin n) Source #
Instance details Defined in Cybus.Fin type Rep (Fin n) = D1 ('MetaData "Fin" "Cybus.Fin" "cybus-0.2.0.0-5MGnPC0rvDP5BLNjb43WK9" 'False) (C1 ('MetaCons "Fin'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pos) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pos)))