-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Collection of types for natural language
--   
--   Types used for natural language applications. Includes an internalized
--   text type, <tt>BTI</tt> which represents internalized <tt>Text</tt>
--   values with <tt>Int</tt>s.
@package LinguisticsTypes
@version 0.0.0.3


-- | This module keeps a persistent <tt>bimap</tt> between <tt>Text</tt>s
--   and <tt>Int</tt>s.
module NLP.Text.BTI.Internal
btiBimap :: IORef (Bimap (HashMap ByteString Int) (Vector ByteString))

-- | Add <tt>UTF8 ByteString</tt> and return <tt>Int</tt> key. Will return
--   key for existing string and thereby serves for lookup in left-to-right
--   direction.
btiBimapAdd :: ByteString -> Int

-- | Lookup the <tt>InternedMultiChar</tt> based on an <tt>Int</tt> key.
--   Unsafe totality assumption.
btiBimapLookupInt :: Int -> ByteString


-- | An implementation of <tt>Int</tt>-mapped <tt>Text</tt>s with
--   internalization. Wrap a <tt>Text</tt> with <a>bti</a> to receive a
--   <tt>BTI</tt>. This internalizes the given <tt>Text</tt>, meaning that
--   two text inputs <tt>x</tt> and <tt>y</tt> will yield the same
--   <tt>BTI</tt> if they have the same textual representation.
--   
--   Since internalized <tt>Text</tt> values are never released, be sure to
--   use it sparingly. I.e. to internalize words, not full sentences.
module NLP.Text.BTI

-- | A <tt>BTI</tt> behaves much like a <tt>Text</tt>, but is represented
--   as an <tt>Int</tt> internally.
newtype BTI
BTI :: Int -> BTI
[getBTI] :: BTI -> Int

-- | Handy wrapper to internalize a <tt>Text</tt> and get a <a>BTI</a>.
bti :: Text -> BTI
btiFromCS :: ConvertibleStrings x Text => x -> BTI
btiToCS :: ConvertibleStrings Text x => BTI -> x
btiToText :: BTI -> Text
btiToUtf8 :: BTI -> ByteString
instance Data.Vector.Unboxed.Base.Unbox NLP.Text.BTI.BTI
instance Data.Vector.Generic.Mutable.Base.MVector Data.Vector.Unboxed.Base.MVector NLP.Text.BTI.BTI
instance Data.Vector.Generic.Base.Vector Data.Vector.Unboxed.Base.Vector NLP.Text.BTI.BTI
instance GHC.Classes.Ord NLP.Text.BTI.BTI
instance Data.String.IsString NLP.Text.BTI.BTI
instance GHC.Show.Show NLP.Text.BTI.BTI
instance GHC.Read.Read NLP.Text.BTI.BTI
instance Data.Hashable.Class.Hashable NLP.Text.BTI.BTI
instance Control.DeepSeq.NFData NLP.Text.BTI.BTI
instance Data.Binary.Class.Binary NLP.Text.BTI.BTI
instance Data.Serialize.Serialize NLP.Text.BTI.BTI
instance Data.Aeson.Types.FromJSON.FromJSON NLP.Text.BTI.BTI
instance Data.Aeson.Types.ToJSON.ToJSON NLP.Text.BTI.BTI
instance GHC.Generics.Generic NLP.Text.BTI.BTI
instance GHC.Classes.Eq NLP.Text.BTI.BTI


-- | Assorted types used in linguistics.
module Linguistics.Types

-- | Concept
--   
--   TODO ???
newtype Concept
Concept :: Text -> Concept
[getConcept] :: Concept -> Text

-- | TODO ???
newtype Counterpart
Counterpart :: Text -> Counterpart
[getCountpart] :: Counterpart -> Text

-- | A word in phonetic <tt>IPA</tt> notation.
newtype IPA
IPA :: Text -> IPA
[getIPA] :: IPA -> Text

-- | TODO ???
newtype Doculect
Doculect :: Text -> Doculect
[getDoculect] :: Doculect -> Text
instance GHC.Generics.Generic Linguistics.Types.Doculect
instance GHC.Classes.Ord Linguistics.Types.Doculect
instance GHC.Classes.Eq Linguistics.Types.Doculect
instance GHC.Generics.Generic Linguistics.Types.IPA
instance GHC.Classes.Ord Linguistics.Types.IPA
instance GHC.Classes.Eq Linguistics.Types.IPA
instance GHC.Generics.Generic Linguistics.Types.Counterpart
instance GHC.Classes.Ord Linguistics.Types.Counterpart
instance GHC.Classes.Eq Linguistics.Types.Counterpart
instance GHC.Generics.Generic Linguistics.Types.Concept
instance GHC.Classes.Ord Linguistics.Types.Concept
instance GHC.Classes.Eq Linguistics.Types.Concept
instance Data.Binary.Class.Binary Linguistics.Types.Concept
instance Data.Serialize.Serialize Linguistics.Types.Concept
instance Data.Aeson.Types.FromJSON.FromJSON Linguistics.Types.Concept
instance Data.Aeson.Types.ToJSON.ToJSON Linguistics.Types.Concept
instance Data.Binary.Class.Binary Linguistics.Types.Counterpart
instance Data.Serialize.Serialize Linguistics.Types.Counterpart
instance Data.Aeson.Types.FromJSON.FromJSON Linguistics.Types.Counterpart
instance Data.Aeson.Types.ToJSON.ToJSON Linguistics.Types.Counterpart
instance Data.Binary.Class.Binary Linguistics.Types.IPA
instance Data.Serialize.Serialize Linguistics.Types.IPA
instance Data.Aeson.Types.FromJSON.FromJSON Linguistics.Types.IPA
instance Data.Aeson.Types.ToJSON.ToJSON Linguistics.Types.IPA
instance Data.Binary.Class.Binary Linguistics.Types.Doculect
instance Data.Serialize.Serialize Linguistics.Types.Doculect
instance Data.Aeson.Types.FromJSON.FromJSON Linguistics.Types.Doculect
instance Data.Aeson.Types.ToJSON.ToJSON Linguistics.Types.Doculect