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


-- | SmallArray-based extensible records for small-scale fast reads
--   
--   Please see the README on GitHub at
--   <a>https://github.com/re-xyr/rec-smallarray#readme</a>
@package rec-smallarray
@version 0.1.0.0


-- | This module defines an immutable extensible record type, similar to
--   <tt>vinyl</tt> and <tt>data-diverse</tt>. However this implementation
--   focuses on fast reads, hence has very different performance
--   characteristics from other libraries:
--   
--   <ul>
--   <li>Lookup: Amortized &lt;math&gt;.</li>
--   <li>Update: &lt;math&gt;.</li>
--   <li>Shrink: &lt;math&gt;.</li>
--   <li>Append: &lt;math&gt;.</li>
--   </ul>
module Data.Rec.SmallArray

-- | Extensible record type supporting efficient &lt;math&gt; reads. The
--   underlying implementation is <a>SmallArray</a> slices, therefore suits
--   small numbers of entries (<i>i.e.</i> less than 128).
data Rec (f :: k -> Type) (es :: [k])

-- | Get the length of the record.
length :: Rec f es -> Int

-- | Create an empty record. &lt;math&gt;.
empty :: Rec f '[]

-- | Create a record with one entry. &lt;math&gt;.
singleton :: f e -> Rec f '[e]

-- | Prepend one entry to the record. &lt;math&gt;.
cons :: f e -> Rec f es -> Rec f (e : es)

-- | Infix version of <a>cons</a> that also supports destructuring.
pattern (:~:) :: f e -> Rec f es -> Rec f (e : es)
infixr 5 :~:

-- | Type level list concatenation.
type family xs ++ ys
infixr 5 ++

-- | Concatenate two records. &lt;math&gt;.
concat :: Rec f es -> Rec f es' -> Rec f (es ++ es')

-- | Infix version of <a>concat</a> that also supports destructuring.
pattern (:++:) :: forall es es' f. KnownList es => Rec f es -> Rec f es' -> Rec f (es ++ es')
infixr 5 :++:

-- | Slice off one entry from the top of the record. &lt;math&gt;.
tail :: Rec f (e : es) -> Rec f es

-- | The list <tt>es</tt> list is concrete, i.e. is of the form <tt>'[a1,
--   a2, ..., an]</tt>, i.e. is not a type variable.
class KnownList (es :: [k])

-- | Slice off several entries from the top of the record. &lt;math&gt;.
drop :: forall es es' f. KnownList es => Rec f (es ++ es') -> Rec f es'

-- | Get the head of the record. &lt;math&gt;.
head :: Rec f (e : es) -> f e

-- | Take elements from the top of the record. &lt;math&gt;.
take :: forall es es' f. KnownList es => Rec f (es ++ es') -> Rec f es

-- | The element <tt>e</tt> is present in the list <tt>es</tt>.
class Elem (e :: k) (es :: [k])

-- | Get an element in the record. Amortized &lt;math&gt;.
index :: forall e es f. Elem e es => Rec f es -> f e

-- | <tt>es</tt> is a subset of <tt>es'</tt>.
class KnownList es => Subset (es :: [k]) (es' :: [k])

-- | Get a subset of the record. Amortized &lt;math&gt;.
pick :: forall es es' f. Subset es es' => Rec f es' -> Rec f es

-- | Update an entry in the record. &lt;math&gt;.
update :: forall e es f. Elem e es => f e -> Rec f es -> Rec f es

-- | Infix version of <a>update</a>.
(/~/) :: Elem e es => f e -> Rec f es -> Rec f es
infixl 9 /~/

-- | Modify an entry in the record via a function. &lt;math&gt;.
modify :: forall e es f. Elem e es => (f e -> f e) -> Rec f es -> Rec f es

-- | Merge a subset into the original record, updating several entries at
--   once. &lt;math&gt;.
batch :: forall es es' f. Subset es es' => Rec f es -> Rec f es' -> Rec f es'

-- | Infix version of <a>batch</a>.
(/++/) :: Subset es es' => Rec f es -> Rec f es' -> Rec f es'
infixl 9 /++/

-- | The type of natural transformations from functor <tt>f</tt> to
--   <tt>g</tt>.
type f ~> g = forall a. f a -> g a
infixr 0 ~>

-- | Apply a natural transformation to the record. &lt;math&gt;.
natural :: (f ~> g) -> Rec f es -> Rec g es

-- | Infix version of <a>natural</a>.
(<#>) :: (f ~> g) -> Rec f es -> Rec g es
infixl 4 <#>

-- | Zip two records with a natural transformation. &lt;math&gt;.
zipWith :: (forall x. f x -> g x -> h x) -> Rec f es -> Rec g es -> Rec h es

-- | Check if a predicate is true on all elements. &lt;math&gt;.
all :: (forall x. f x -> Bool) -> Rec f es -> Bool

-- | Check if a predicate is true on at least one element. &lt;math&gt;.
any :: (forall x. f x -> Bool) -> Rec f es -> Bool

-- | Convert a record that effectively contains a fixed type into a list of
--   the fixed type. &lt;math&gt;.
degenerate :: Rec (Const a) es -> [a]

-- | Map each element to a fixed type. &lt;math&gt;.
extract :: (forall x. f x -> a) -> Rec f es -> [a]

-- | Test all invariants.
invariant :: Rec f es -> Rec f es

-- | Test the size invariant of <a>Rec</a>.
sizeInvariant :: Rec f es -> Rec f es

-- | Test whether all fields of <a>Rec</a> are really set.
allAccessible :: Rec f es -> Rec f es
instance forall k (es :: [k]). Data.Rec.SmallArray.Subset '[] es
instance forall k (es :: [k]) (es' :: [k]) (e :: k). (Data.Rec.SmallArray.Subset es es', Data.Rec.SmallArray.Elem e es') => Data.Rec.SmallArray.Subset (e : es) es'
instance forall k (e :: k). (TypeError ...) => Data.Rec.SmallArray.Elem e '[]
instance forall a (e :: a) (es :: [a]). Data.Rec.SmallArray.Elem e (e : es)
instance forall a (e :: a) (es :: [a]) (e' :: a). Data.Rec.SmallArray.Elem e es => Data.Rec.SmallArray.Elem e (e' : es)
instance Data.Rec.SmallArray.KnownList '[]
instance forall k (es :: [k]) (e :: k). Data.Rec.SmallArray.KnownList es => Data.Rec.SmallArray.KnownList (e : es)
instance forall k (f :: k -> Type). GHC.Classes.Eq (Data.Rec.SmallArray.Rec f '[])
instance forall a (f :: a -> Type) (xs :: [a]) (x :: a). (GHC.Classes.Eq (Data.Rec.SmallArray.Rec f xs), GHC.Classes.Eq (f x)) => GHC.Classes.Eq (Data.Rec.SmallArray.Rec f (x : xs))
instance forall k (f :: k -> Type) (xs :: [k]). (forall (x :: k). GHC.Classes.Eq (f x)) => GHC.Classes.Eq (Data.Rec.SmallArray.Rec f xs)
instance forall k (f :: k -> Type). GHC.Show.Show (Data.Rec.SmallArray.Rec f '[])
instance forall k (f :: k -> Type). GHC.Read.Read (Data.Rec.SmallArray.Rec f '[])
instance forall a (f :: a -> Type) (x :: a) (xs :: [a]). (GHC.Show.Show (f x), GHC.Show.Show (Data.Rec.SmallArray.Rec f xs)) => GHC.Show.Show (Data.Rec.SmallArray.Rec f (x : xs))
instance forall a (f :: a -> Type) (x :: a) (xs :: [a]). (GHC.Read.Read (f x), GHC.Read.Read (Data.Rec.SmallArray.Rec f xs)) => GHC.Read.Read (Data.Rec.SmallArray.Rec f (x : xs))
instance forall k (f :: k -> Type) (xs :: [k]). (forall (x :: k). GHC.Show.Show (f x)) => GHC.Show.Show (Data.Rec.SmallArray.Rec f xs)
instance forall k (f :: k -> Type). GHC.Base.Semigroup (Data.Rec.SmallArray.Rec f '[])
instance forall a (f :: a -> Type) (x :: a) (xs :: [a]). (GHC.Base.Semigroup (f x), GHC.Base.Semigroup (Data.Rec.SmallArray.Rec f xs)) => GHC.Base.Semigroup (Data.Rec.SmallArray.Rec f (x : xs))
instance forall k (f :: k -> Type) (xs :: [k]). (forall (x :: k). GHC.Base.Semigroup (f x)) => GHC.Base.Semigroup (Data.Rec.SmallArray.Rec f xs)
instance forall k (f :: k -> Type). GHC.Base.Monoid (Data.Rec.SmallArray.Rec f '[])
instance forall a (f :: a -> Type) (x :: a) (xs :: [a]). (GHC.Base.Monoid (f x), GHC.Base.Monoid (Data.Rec.SmallArray.Rec f xs)) => GHC.Base.Monoid (Data.Rec.SmallArray.Rec f (x : xs))