Safe Haskell	None
Language	Haskell2010

Biobase.Types.ReadingFrame

Description

Stranded reading frames.

Synopsis

newtype ReadingFrame = ReadingFrame {
- getReadingFrame :: Int
}
rf :: Prism' Int ReadingFrame
strandRF :: Lens' ReadingFrame Strand
fromIndex :: Index 1 -> ReadingFrame

Documentation

newtype ReadingFrame Source #

The Reading frame. Sequence indexing starts at position 1, which starts reading frame 1. Reading frame 2 and 3 start at position 2 and 3 respectively.

Constructors

ReadingFrame
Fields getReadingFrame :: Int

Instances

Instances details

Enum ReadingFrame Source #	`pred` and `succ` are correct, if the input is a legal `ReadingFrame`.
Instance details Defined in Biobase.Types.ReadingFrame Methods succ :: ReadingFrame -> ReadingFrame # pred :: ReadingFrame -> ReadingFrame # toEnum :: Int -> ReadingFrame # fromEnum :: ReadingFrame -> Int # enumFrom :: ReadingFrame -> [ReadingFrame] # enumFromThen :: ReadingFrame -> ReadingFrame -> [ReadingFrame] # enumFromTo :: ReadingFrame -> ReadingFrame -> [ReadingFrame] # enumFromThenTo :: ReadingFrame -> ReadingFrame -> ReadingFrame -> [ReadingFrame] #
Eq ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame Methods (==) :: ReadingFrame -> ReadingFrame -> Bool # (/=) :: ReadingFrame -> ReadingFrame -> Bool #
Ord ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame Methods compare :: ReadingFrame -> ReadingFrame -> Ordering # (<) :: ReadingFrame -> ReadingFrame -> Bool # (<=) :: ReadingFrame -> ReadingFrame -> Bool # (>) :: ReadingFrame -> ReadingFrame -> Bool # (>=) :: ReadingFrame -> ReadingFrame -> Bool # max :: ReadingFrame -> ReadingFrame -> ReadingFrame # min :: ReadingFrame -> ReadingFrame -> ReadingFrame #
Show ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame Methods showsPrec :: Int -> ReadingFrame -> ShowS # show :: ReadingFrame -> String # showList :: [ReadingFrame] -> ShowS #
Generic ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame Associated Types type Rep ReadingFrame :: Type -> Type # Methods from :: ReadingFrame -> Rep ReadingFrame x # to :: Rep ReadingFrame x -> ReadingFrame #
Wrapped ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame Associated Types type Unwrapped ReadingFrame # Methods _Wrapped' :: Iso' ReadingFrame (Unwrapped ReadingFrame) #
ReadingFrame ~ t => Rewrapped ReadingFrame t Source #
Instance details Defined in Biobase.Types.ReadingFrame
type Rep ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame type Rep ReadingFrame = D1 ('MetaData "ReadingFrame" "Biobase.Types.ReadingFrame" "BiobaseTypes-0.2.1.0-KNWEaQoA0aY419BnftjfF1" 'True) (C1 ('MetaCons "ReadingFrame" 'PrefixI 'True) (S1 ('MetaSel ('Just "getReadingFrame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))
type Unwrapped ReadingFrame Source #
Instance details Defined in Biobase.Types.ReadingFrame type Unwrapped ReadingFrame = Int

rf :: Prism' Int ReadingFrame Source #

Convert between +1 ... +3 and ReadingFrame.

strandRF :: Lens' ReadingFrame Strand Source #

A lens for the strand

fromIndex :: Index 1 -> ReadingFrame Source #

TODO should this be a type class, since we might reasonably want to construct from a number of possible indices?