Biobase.Types.Names

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.

Int-internalized species names.

newtype SpeciesName

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

Constructors

SpeciesName

Fields

• getSpeciesNameRep :: Int

Instances

Eq SpeciesName

Methods

(==) :: SpeciesName -> SpeciesName -> Bool

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

Ord SpeciesName

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

Methods

readsPrec :: Int -> ReadS SpeciesName

readList :: ReadS [SpeciesName]

readPrec :: ReadPrec SpeciesName

readListPrec :: ReadPrec [SpeciesName]

Show SpeciesName

Methods

showsPrec :: Int -> SpeciesName -> ShowS

show :: SpeciesName -> String

showList :: [SpeciesName] -> ShowS

IsString SpeciesName

Methods

fromString :: String -> SpeciesName

Generic SpeciesName

Associated Types

type Rep SpeciesName :: * -> *

Methods

from :: SpeciesName -> Rep SpeciesName x

to :: Rep SpeciesName x -> SpeciesName

Hashable SpeciesName

Methods

hashWithSalt :: Int -> SpeciesName -> Int

hash :: SpeciesName -> Int

FromJSON SpeciesName

Methods

parseJSON :: Value -> Parser SpeciesName

parseJSONList :: Value -> Parser [SpeciesName]

ToJSON SpeciesName

Methods

toJSON :: SpeciesName -> Value

toEncoding :: SpeciesName -> Encoding

toJSONList :: [SpeciesName] -> Value

toEncodingList :: [SpeciesName] -> Encoding

Binary SpeciesName

Methods

put :: SpeciesName -> Put

get :: Get SpeciesName

Serialize SpeciesName

Methods

put :: Putter SpeciesName

get :: Get SpeciesName

NFData SpeciesName

Methods

rnf :: SpeciesName -> ()

Stringable SpeciesName

Methods

toString :: SpeciesName -> String

fromString :: String -> SpeciesName

length :: SpeciesName -> Int

toText :: SpeciesName -> Text

fromText :: Text -> SpeciesName

toLazyText :: SpeciesName -> Text

fromLazyText :: Text -> SpeciesName

toByteString :: SpeciesName -> ByteString

fromByteString :: ByteString -> SpeciesName

toLazyByteString :: SpeciesName -> ByteString

fromLazyByteString :: ByteString -> SpeciesName

toFilePath :: SpeciesName -> FilePath

fromFilePath :: FilePath -> SpeciesName

Unbox SpeciesName

Vector Vector SpeciesName

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

MVector MVector SpeciesName

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

type Rep SpeciesName = D1 (MetaData "SpeciesName" "Biobase.Types.Names" "BiobaseTypes-0.1.2.0-4orDP6jtu4AAFNWn3qTAP0" True) (C1 (MetaCons "SpeciesName" PrefixI True) (S1 (MetaSel (Just Symbol "getSpeciesNameRep") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

data Vector SpeciesName

data Vector SpeciesName = V_SpeciesName (Vector Int)

data MVector s SpeciesName

data MVector s SpeciesName = MV_SpeciesName (MVector s Int)

speciesName :: Text -> SpeciesName

Smart constructor that performs the correct internalization.

Internalize taxonomic rank names

newtype TaxonomicRank

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

Constructors

TaxonomicRank

Fields

• getTaxonomicRank :: InternedText

Instances

Eq TaxonomicRank

Methods

(==) :: TaxonomicRank -> TaxonomicRank -> Bool

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

Ord TaxonomicRank

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

Methods

readsPrec :: Int -> ReadS TaxonomicRank

readList :: ReadS [TaxonomicRank]

readPrec :: ReadPrec TaxonomicRank

readListPrec :: ReadPrec [TaxonomicRank]

Show TaxonomicRank

Methods

showsPrec :: Int -> TaxonomicRank -> ShowS

show :: TaxonomicRank -> String

showList :: [TaxonomicRank] -> ShowS

IsString TaxonomicRank

Methods

fromString :: String -> TaxonomicRank

Generic TaxonomicRank

Associated Types

type Rep TaxonomicRank :: * -> *

Methods

from :: TaxonomicRank -> Rep TaxonomicRank x

to :: Rep TaxonomicRank x -> TaxonomicRank

Hashable TaxonomicRank

Methods

hashWithSalt :: Int -> TaxonomicRank -> Int

hash :: TaxonomicRank -> Int

FromJSON TaxonomicRank

Methods

parseJSON :: Value -> Parser TaxonomicRank

parseJSONList :: Value -> Parser [TaxonomicRank]

ToJSON TaxonomicRank

Methods

toJSON :: TaxonomicRank -> Value

toEncoding :: TaxonomicRank -> Encoding

toJSONList :: [TaxonomicRank] -> Value

toEncodingList :: [TaxonomicRank] -> Encoding

Binary TaxonomicRank

Methods

put :: TaxonomicRank -> Put

get :: Get TaxonomicRank

Serialize TaxonomicRank

Methods

put :: Putter TaxonomicRank

get :: Get TaxonomicRank

NFData TaxonomicRank

Methods

rnf :: TaxonomicRank -> ()

Stringable TaxonomicRank

Methods

toString :: TaxonomicRank -> String

fromString :: String -> TaxonomicRank

length :: TaxonomicRank -> Int

toText :: TaxonomicRank -> Text

fromText :: Text -> TaxonomicRank

toLazyText :: TaxonomicRank -> Text

fromLazyText :: Text -> TaxonomicRank

toByteString :: TaxonomicRank -> ByteString

fromByteString :: ByteString -> TaxonomicRank

toLazyByteString :: TaxonomicRank -> ByteString

fromLazyByteString :: ByteString -> TaxonomicRank

toFilePath :: TaxonomicRank -> FilePath

fromFilePath :: FilePath -> TaxonomicRank

type Rep TaxonomicRank

type Rep TaxonomicRank = D1 (MetaData "TaxonomicRank" "Biobase.Types.Names" "BiobaseTypes-0.1.2.0-4orDP6jtu4AAFNWn3qTAP0" True) (C1 (MetaCons "TaxonomicRank" PrefixI True) (S1 (MetaSel (Just Symbol "getTaxonomicRank") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InternedText)))