Safe Haskell	None
Language	Haskell2010

Biobase.Types.Index.Type

Synopsis

newtype Index (t :: Nat) = Index {
- getIndex :: Int
}
index :: forall t. KnownNat t => Int -> Index t
maybeIndex :: forall t. KnownNat t => Int -> Maybe (Index t)

Documentation

newtype Index (t :: Nat) Source #

A linear Int-based index type.

Constructors

Index
Fields getIndex :: Int

Instances

Vector Vector (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) (Index t) -> m (Vector (Index t)) # basicUnsafeThaw :: PrimMonad m => Vector (Index t) -> m (Mutable Vector (PrimState m) (Index t)) # basicLength :: Vector (Index t) -> Int # basicUnsafeSlice :: Int -> Int -> Vector (Index t) -> Vector (Index t) # basicUnsafeIndexM :: Monad m => Vector (Index t) -> Int -> m (Index t) # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) (Index t) -> Vector (Index t) -> m () # elemseq :: Vector (Index t) -> Index t -> b -> b #
MVector MVector (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods basicLength :: MVector s (Index t) -> Int # basicUnsafeSlice :: Int -> Int -> MVector s (Index t) -> MVector s (Index t) # basicOverlaps :: MVector s (Index t) -> MVector s (Index t) -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (Index t)) # basicInitialize :: PrimMonad m => MVector (PrimState m) (Index t) -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> Index t -> m (MVector (PrimState m) (Index t)) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (Index t) -> Int -> m (Index t) # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (Index t) -> Int -> Index t -> m () # basicClear :: PrimMonad m => MVector (PrimState m) (Index t) -> m () # basicSet :: PrimMonad m => MVector (PrimState m) (Index t) -> Index t -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (Index t) -> MVector (PrimState m) (Index t) -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (Index t) -> MVector (PrimState m) (Index t) -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (Index t) -> Int -> m (MVector (PrimState m) (Index t)) #
Eq (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods (==) :: Index t -> Index t -> Bool # (/=) :: Index t -> Index t -> Bool #
KnownNat t => Num (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods (+) :: Index t -> Index t -> Index t # (-) :: Index t -> Index t -> Index t # (*) :: Index t -> Index t -> Index t # negate :: Index t -> Index t # abs :: Index t -> Index t # signum :: Index t -> Index t # fromInteger :: Integer -> Index t #
Ord (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods compare :: Index t -> Index t -> Ordering # (<) :: Index t -> Index t -> Bool # (<=) :: Index t -> Index t -> Bool # (>) :: Index t -> Index t -> Bool # (>=) :: Index t -> Index t -> Bool # max :: Index t -> Index t -> Index t # min :: Index t -> Index t -> Index t #
Read (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods readsPrec :: Int -> ReadS (Index t) # readList :: ReadS [Index t] # readPrec :: ReadPrec (Index t) # readListPrec :: ReadPrec [Index t] #
Show (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods showsPrec :: Int -> Index t -> ShowS # show :: Index t -> String # showList :: [Index t] -> ShowS #
Ix (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods range :: (Index t, Index t) -> [Index t] # index :: (Index t, Index t) -> Index t -> Int # unsafeIndex :: (Index t, Index t) -> Index t -> Int inRange :: (Index t, Index t) -> Index t -> Bool # rangeSize :: (Index t, Index t) -> Int # unsafeRangeSize :: (Index t, Index t) -> Int
Generic (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Associated Types type Rep (Index t) :: Type -> Type # Methods from :: Index t -> Rep (Index t) x # to :: Rep (Index t) x -> Index t #
KnownNat t => Index (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Associated Types data LimitType (Index t) :: Type # Methods linearIndex :: LimitType (Index t) -> Index t -> Int # size :: LimitType (Index t) -> Int # inBounds :: LimitType (Index t) -> Index t -> Bool # zeroBound :: Index t # zeroBound' :: LimitType (Index t) # totalSize :: LimitType (Index t) -> [Integer] #
KnownNat t => IndexStream (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods streamUp :: Monad m => LimitType (Index t) -> LimitType (Index t) -> Stream m (Index t) # streamDown :: Monad m => LimitType (Index t) -> LimitType (Index t) -> Stream m (Index t) #
Arbitrary (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods arbitrary :: Gen (Index t) # shrink :: Index t -> [Index t] #
Hashable (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods hashWithSalt :: Int -> Index t -> Int # hash :: Index t -> Int #
ToJSON (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods toJSON :: Index t -> Value # toEncoding :: Index t -> Encoding # toJSONList :: [Index t] -> Value # toEncodingList :: [Index t] -> Encoding #
FromJSON (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods parseJSON :: Value -> Parser (Index t) # parseJSONList :: Value -> Parser [Index t] #
Binary (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods put :: Index t -> Put # get :: Get (Index t) # putList :: [Index t] -> Put #
Serialize (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods put :: Putter (Index t) # get :: Get (Index t) #
NFData (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods rnf :: Index t -> () #
Unbox (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type
(KnownNat t, IndexStream z) => IndexStream (z :. Index t) Source #
Instance details Defined in Biobase.Types.Index.Type Methods streamUp :: Monad m => LimitType (z :. Index t) -> LimitType (z :. Index t) -> Stream m (z :. Index t) # streamDown :: Monad m => LimitType (z :. Index t) -> LimitType (z :. Index t) -> Stream m (z :. Index t) #
data MVector s (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type data MVector s (Index t) = MV_Index (MVector s Int)
type Rep (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type type Rep (Index t) = D1 (MetaData "Index" "Biobase.Types.Index.Type" "BiobaseTypes-0.1.4.0-2SJmLmHyrafG90Dl3d2I5j" True) (C1 (MetaCons "Index" PrefixI True) (S1 (MetaSel (Just "getIndex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))
data LimitType (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type data LimitType (Index t) = LtIndex Int
data Vector (Index t) Source #
Instance details Defined in Biobase.Types.Index.Type data Vector (Index t) = V_Index (Vector Int)

index :: forall t. KnownNat t => Int -> Index t Source #

Turn an Int into an Index safely.

maybeIndex :: forall t. KnownNat t => Int -> Maybe (Index t) Source #

Produce Just and Index or Nothing.