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


-- | Lightweight strict types
--   
--   Lightweight, zero-cost strict versions of basic data types
@package strict-wrapper
@version 0.0.0.0

module Data.Strict.Wrapper

-- | Use the <tt>Strict</tt> pattern if you want to subsequently match on
--   the <tt>t</tt> it contains (otherwise it is more efficient to use
--   <a>strict</a>).
--   
--   <pre>
--   printIt :: Strict (Maybe Int) -&gt; IO ()
--   printIt (Strict (Just i)) = print i
--   printIt (Strict Nothing)  = putStrLn "Nothing there"
--   </pre>
--   
--   Make a <tt>Strict t</tt> using the <tt>Strict</tt> constructor if you
--   are constructing it from its individual fields (otherwise it is more
--   efficient to use <a>unstrict</a>).
--   
--   <pre>
--   makeStrict :: Int -&gt; Strict (Int, String)
--   makeStrict i = Strict (i + 1, show i)
--   </pre>
pattern Strict :: Strictly t => t -> Strict t

-- | Isomorphic to the type <tt>t</tt>, except that when it is evaulated
--   its immediate children are evaluated too.
data family Strict t

-- | Make a <tt>Strict t</tt> using <a>strict</a> if you obtained a whole
--   <tt>t</tt> from elsewhere (otherwise, if you have the components of
--   <tt>t</tt> separately, then it is more efficient to use the
--   <a>Strict</a> constructor instead).
--   
--   <pre>
--   makeStrict :: (Int, Strict (Int, String)) -&gt; Int
--   makeStrict (i, s) = i + f (strict s)
--   </pre>
strict :: Strictly t => t -> Strict t

-- | Access the contents of a <tt>Strict t</tt>, but not its fields, using
--   <tt>unstrict</tt> (if you want access to the fields then it is more
--   efficient to use the <a>Strict</a> pattern).
--   
--   <pre>
--   strictMaybe :: r -&gt; (a -&gt; r) -&gt; Strict (Maybe a) -&gt; r
--   strictMaybe r f sm = maybe r f (unstrict sm)
--   </pre>
unstrict :: Strictly t => Strict t -> t

-- | A type <tt>t</tt> can be given a <tt>Strictly</tt> instance when it
--   has a very cheap conversion to and from a strict type, <tt>Strict
--   t</tt>.
class Strictly t

-- | Used to implement the <a>Strict</a> pattern synonym. You should never
--   need to use <tt>matchStrict</tt> unless you are defining your own
--   instance of <tt>Strictly</tt>.
matchStrict :: Strictly t => Strict t -> t

-- | Used to implement the <a>Strict</a> constructor. You should never need
--   to use <tt>constructStrict</tt> unless you are defining your own
--   instance of <tt>Strictly</tt>.
constructStrict :: Strictly t => t -> Strict t

-- | Some data types, such as <a>Int</a> and <a>Double</a>, are already as
--   strict as they can be. There is no need to wrap them in <a>Strict</a>!
type family AlreadyStrict t :: Constraint

-- | Some data types, such as <tt>[a]</tt>, can't be made strict in a
--   zero-cost way.
type family CannotBeStrict t :: Constraint

-- | It is redundant to nest <a>Strict</a>, e.g. <tt>Strict (Strict (t1,
--   t2))</tt>. Just use one layer of <a>Strict</a>.
type family NestedStrict t :: Constraint

-- | Some <a>Strictly</a> instances are not yet implemented. Please file an
--   issue if you need them.
type family NotYetImplemented t :: Constraint
instance Data.Strict.Wrapper.NestedStrict t => Data.Strict.Wrapper.Strictly (Data.Strict.Wrapper.Strict t)
instance Data.Strict.Wrapper.NotYetImplemented (x1, x2, x3, x4, x5) => Data.Strict.Wrapper.Strictly (x1, x2, x3, x4, x5)
instance Data.Strict.Wrapper.NotYetImplemented (x1, x2, x3, x4, x5, x6) => Data.Strict.Wrapper.Strictly (x1, x2, x3, x4, x5, x6)
instance Data.Strict.Wrapper.CannotBeStrict [t] => Data.Strict.Wrapper.Strictly [t]
instance Data.Strict.Wrapper.CannotBeStrict (GHC.Types.IO a) => Data.Strict.Wrapper.Strictly (GHC.Types.IO a)
instance Data.Strict.Wrapper.AlreadyStrict () => Data.Strict.Wrapper.Strictly ()
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Bool => Data.Strict.Wrapper.Strictly GHC.Types.Bool
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Int => Data.Strict.Wrapper.Strictly GHC.Types.Int
instance Data.Strict.Wrapper.AlreadyStrict GHC.Integer.Type.Integer => Data.Strict.Wrapper.Strictly GHC.Integer.Type.Integer
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Float => Data.Strict.Wrapper.Strictly GHC.Types.Float
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Double => Data.Strict.Wrapper.Strictly GHC.Types.Double
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Word => Data.Strict.Wrapper.Strictly GHC.Types.Word
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Ordering => Data.Strict.Wrapper.Strictly GHC.Types.Ordering
instance Data.Strict.Wrapper.AlreadyStrict GHC.Types.Char => Data.Strict.Wrapper.Strictly GHC.Types.Char
instance Data.Strict.Wrapper.Strictly (t1, t2)
instance Data.Strict.Wrapper.Strictly (t1, t2, t3)
instance Data.Strict.Wrapper.Strictly (t1, t2, t3, t4)
instance Data.Strict.Wrapper.Strictly (GHC.Maybe.Maybe t)
instance Data.Strict.Wrapper.Strictly (Data.Either.Either t1 t2)