Safe Haskell	None
Language	Haskell2010

Biobase.Types.Names

Contents

Int-internalized species names.
Internalize taxonomic rank names

Description

Names for biological things.

Species names are internalized and represented as an Int. This allows using them in structures like an IntMap.

For other names, we newtype-wrap normal text internalization.

Synopsis

newtype SpeciesName = SpeciesName {
- getSpeciesNameRep :: Int
}
speciesName :: Text -> SpeciesName
newtype TaxonomicRank = TaxonomicRank {
- getTaxonomicRank :: InternedText
}

Int-internalized species names.

newtype SpeciesName Source #

A species name. Represented with an Int, but behaves like a Text.

Constructors

SpeciesName
Fields getSpeciesNameRep :: Int

Instances

Eq SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods (==) :: SpeciesName -> SpeciesName -> Bool # (/=) :: SpeciesName -> SpeciesName -> Bool #
Ord SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods compare :: SpeciesName -> SpeciesName -> Ordering # (<) :: SpeciesName -> SpeciesName -> Bool # (<=) :: SpeciesName -> SpeciesName -> Bool # (>) :: SpeciesName -> SpeciesName -> Bool # (>=) :: SpeciesName -> SpeciesName -> Bool # max :: SpeciesName -> SpeciesName -> SpeciesName # min :: SpeciesName -> SpeciesName -> SpeciesName #
Read SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods readsPrec :: Int -> ReadS SpeciesName # readList :: ReadS [SpeciesName] # readPrec :: ReadPrec SpeciesName # readListPrec :: ReadPrec [SpeciesName] #
Show SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods showsPrec :: Int -> SpeciesName -> ShowS # show :: SpeciesName -> String # showList :: [SpeciesName] -> ShowS #
IsString SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods fromString :: String -> SpeciesName #
Generic SpeciesName Source #
Instance details Defined in Biobase.Types.Names Associated Types type Rep SpeciesName :: Type -> Type # Methods from :: SpeciesName -> Rep SpeciesName x # to :: Rep SpeciesName x -> SpeciesName #
NFData SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods rnf :: SpeciesName -> () #
Hashable SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods hashWithSalt :: Int -> SpeciesName -> Int # hash :: SpeciesName -> Int #
ToJSON SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods toJSON :: SpeciesName -> Value # toEncoding :: SpeciesName -> Encoding # toJSONList :: [SpeciesName] -> Value # toEncodingList :: [SpeciesName] -> Encoding #
FromJSON SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods parseJSON :: Value -> Parser SpeciesName # parseJSONList :: Value -> Parser [SpeciesName] #
Binary SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods put :: SpeciesName -> Put # get :: Get SpeciesName # putList :: [SpeciesName] -> Put #
Serialize SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods put :: Putter SpeciesName # get :: Get SpeciesName #
Unbox SpeciesName Source #
Instance details Defined in Biobase.Types.Names
Vector Vector SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) SpeciesName -> m (Vector SpeciesName) # basicUnsafeThaw :: PrimMonad m => Vector SpeciesName -> m (Mutable Vector (PrimState m) SpeciesName) # basicLength :: Vector SpeciesName -> Int # basicUnsafeSlice :: Int -> Int -> Vector SpeciesName -> Vector SpeciesName # basicUnsafeIndexM :: Monad m => Vector SpeciesName -> Int -> m SpeciesName # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) SpeciesName -> Vector SpeciesName -> m () # elemseq :: Vector SpeciesName -> SpeciesName -> b -> b #
ConvertibleStrings Text SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods convertString :: Text -> SpeciesName #
ConvertibleStrings SpeciesName Text Source #
Instance details Defined in Biobase.Types.Names Methods convertString :: SpeciesName -> Text #
MVector MVector SpeciesName Source #
Instance details Defined in Biobase.Types.Names Methods basicLength :: MVector s SpeciesName -> Int # basicUnsafeSlice :: Int -> Int -> MVector s SpeciesName -> MVector s SpeciesName # basicOverlaps :: MVector s SpeciesName -> MVector s SpeciesName -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) SpeciesName) # basicInitialize :: PrimMonad m => MVector (PrimState m) SpeciesName -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> SpeciesName -> m (MVector (PrimState m) SpeciesName) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) SpeciesName -> Int -> m SpeciesName # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) SpeciesName -> Int -> SpeciesName -> m () # basicClear :: PrimMonad m => MVector (PrimState m) SpeciesName -> m () # basicSet :: PrimMonad m => MVector (PrimState m) SpeciesName -> SpeciesName -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) SpeciesName -> MVector (PrimState m) SpeciesName -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) SpeciesName -> MVector (PrimState m) SpeciesName -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) SpeciesName -> Int -> m (MVector (PrimState m) SpeciesName) #
type Rep SpeciesName Source #
Instance details Defined in Biobase.Types.Names type Rep SpeciesName = D1 (MetaData "SpeciesName" "Biobase.Types.Names" "BiobaseTypes-0.2.0.1-B9coIbijR6NEFcCxvqIOZp" True) (C1 (MetaCons "SpeciesName" PrefixI True) (S1 (MetaSel (Just "getSpeciesNameRep") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))
newtype Vector SpeciesName Source #
Instance details Defined in Biobase.Types.Names newtype Vector SpeciesName = V_SpeciesName (Vector Int)
newtype MVector s SpeciesName Source #
Instance details Defined in Biobase.Types.Names newtype MVector s SpeciesName = MV_SpeciesName (MVector s Int)

speciesName :: Text -> SpeciesName Source #

Smart constructor that performs the correct internalization.

Internalize taxonomic rank names

newtype TaxonomicRank Source #

The taxonomic rank. This encodes the name for a given rank.

Constructors

TaxonomicRank
Fields getTaxonomicRank :: InternedText

Instances

Eq TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods (==) :: TaxonomicRank -> TaxonomicRank -> Bool # (/=) :: TaxonomicRank -> TaxonomicRank -> Bool #
Ord TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods compare :: TaxonomicRank -> TaxonomicRank -> Ordering # (<) :: TaxonomicRank -> TaxonomicRank -> Bool # (<=) :: TaxonomicRank -> TaxonomicRank -> Bool # (>) :: TaxonomicRank -> TaxonomicRank -> Bool # (>=) :: TaxonomicRank -> TaxonomicRank -> Bool # max :: TaxonomicRank -> TaxonomicRank -> TaxonomicRank # min :: TaxonomicRank -> TaxonomicRank -> TaxonomicRank #
Read TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods readsPrec :: Int -> ReadS TaxonomicRank # readList :: ReadS [TaxonomicRank] # readPrec :: ReadPrec TaxonomicRank # readListPrec :: ReadPrec [TaxonomicRank] #
Show TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods showsPrec :: Int -> TaxonomicRank -> ShowS # show :: TaxonomicRank -> String # showList :: [TaxonomicRank] -> ShowS #
IsString TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods fromString :: String -> TaxonomicRank #
Generic TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Associated Types type Rep TaxonomicRank :: Type -> Type # Methods from :: TaxonomicRank -> Rep TaxonomicRank x # to :: Rep TaxonomicRank x -> TaxonomicRank #
NFData TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods rnf :: TaxonomicRank -> () #
Hashable TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods hashWithSalt :: Int -> TaxonomicRank -> Int # hash :: TaxonomicRank -> Int #
ToJSON TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods toJSON :: TaxonomicRank -> Value # toEncoding :: TaxonomicRank -> Encoding # toJSONList :: [TaxonomicRank] -> Value # toEncodingList :: [TaxonomicRank] -> Encoding #
FromJSON TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods parseJSON :: Value -> Parser TaxonomicRank # parseJSONList :: Value -> Parser [TaxonomicRank] #
Binary TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods put :: TaxonomicRank -> Put # get :: Get TaxonomicRank # putList :: [TaxonomicRank] -> Put #
Serialize TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods put :: Putter TaxonomicRank # get :: Get TaxonomicRank #
ConvertibleStrings Text TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names Methods convertString :: Text -> TaxonomicRank #
ConvertibleStrings TaxonomicRank Text Source #
Instance details Defined in Biobase.Types.Names Methods convertString :: TaxonomicRank -> Text #
type Rep TaxonomicRank Source #
Instance details Defined in Biobase.Types.Names type Rep TaxonomicRank = D1 (MetaData "TaxonomicRank" "Biobase.Types.Names" "BiobaseTypes-0.2.0.1-B9coIbijR6NEFcCxvqIOZp" True) (C1 (MetaCons "TaxonomicRank" PrefixI True) (S1 (MetaSel (Just "getTaxonomicRank") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InternedText)))