Reflex.Query.Class

Documentation

class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where

A Query can be thought of as a declaration of interest in some set of data. A QueryResult is the set of data associated with that interest set. The crop function provides a way to determine what part of a given QueryResult is relevant to a given Query.

Associated Types

type QueryResult a :: Type

Methods

crop :: a -> QueryResult a -> QueryResult a

Instances

Query ()

Trivial queries have trivial results.

Defined in Reflex.Query.Class

Associated Types

type QueryResult () :: Type

Methods

crop :: () -> QueryResult () -> QueryResult ()

Query Void

The result of an absurd query is trivial; If you can ask the question, the answer cannot tell you anything you didn't already know.

'QueryResult Void = Void' seems like it would also work, but that has problems of robustness. In some applications, an unasked question can still be answered, so it is important that the result is inhabited even when the question isn't. Applications that wish to prevent this can mandate that the query result be paired with the query: then the whole response will be uninhabited as desired.

Defined in Reflex.Query.Class

Associated Types

type QueryResult Void :: Type

Methods

crop :: Void -> QueryResult Void -> QueryResult Void

(Query a, Query b) => Query (a, b)

the result of two queries is both results.

Defined in Reflex.Query.Class

Associated Types

type QueryResult (a, b) :: Type

Methods

crop :: (a, b) -> QueryResult (a, b) -> QueryResult (a, b)

(Ord k, Query v) => Query (MonoidalMap k v)

Defined in Reflex.Query.Class

Associated Types

type QueryResult (MonoidalMap k v) :: Type

Methods

crop :: MonoidalMap k v -> QueryResult (MonoidalMap k v) -> QueryResult (MonoidalMap k v)

(Query q, Applicative f) => Query (Ap f q)

We can lift queries into monoidal containers. But beware of Applicatives whose monoid is different from (pure mempty, liftA2 mappend)

Defined in Reflex.Query.Class

Associated Types

type QueryResult (Ap f q) :: Type

Methods

crop :: Ap f q -> QueryResult (Ap f q) -> QueryResult (Ap f q)

data QueryMorphism q q'

QueryMorphism's must be group homomorphisms when acting on the query type and compatible with the query relationship when acting on the query result.

Constructors

QueryMorphism

Fields

• _queryMorphism_mapQuery :: q -> q'
• _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q

Instances

Category QueryMorphism

Defined in Reflex.Query.Class

Methods

id :: QueryMorphism a a

(.) :: QueryMorphism b c -> QueryMorphism a b -> QueryMorphism a c

newtype SelectedCount

This type can be used to track of the frequency of interest in a given Query. See note on combineSelectedCounts

Constructors

SelectedCount

Fields

• unSelectedCount :: Int

Instances

Bounded SelectedCount

Defined in Reflex.Query.Class

Methods

minBound :: SelectedCount

maxBound :: SelectedCount

Enum SelectedCount

Defined in Reflex.Query.Class

Methods

succ :: SelectedCount -> SelectedCount

pred :: SelectedCount -> SelectedCount

toEnum :: Int -> SelectedCount

fromEnum :: SelectedCount -> Int

enumFrom :: SelectedCount -> [SelectedCount]

enumFromThen :: SelectedCount -> SelectedCount -> [SelectedCount]

enumFromTo :: SelectedCount -> SelectedCount -> [SelectedCount]

enumFromThenTo :: SelectedCount -> SelectedCount -> SelectedCount -> [SelectedCount]

Eq SelectedCount

Defined in Reflex.Query.Class

Methods

(==) :: SelectedCount -> SelectedCount -> Bool

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

Integral SelectedCount

Defined in Reflex.Query.Class

Methods

quot :: SelectedCount -> SelectedCount -> SelectedCount

rem :: SelectedCount -> SelectedCount -> SelectedCount

div :: SelectedCount -> SelectedCount -> SelectedCount

mod :: SelectedCount -> SelectedCount -> SelectedCount

quotRem :: SelectedCount -> SelectedCount -> (SelectedCount, SelectedCount)

divMod :: SelectedCount -> SelectedCount -> (SelectedCount, SelectedCount)

toInteger :: SelectedCount -> Integer

Data SelectedCount

Defined in Reflex.Query.Class

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SelectedCount -> c SelectedCount

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SelectedCount

toConstr :: SelectedCount -> Constr

dataTypeOf :: SelectedCount -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SelectedCount)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SelectedCount)

gmapT :: (forall b. Data b => b -> b) -> SelectedCount -> SelectedCount

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SelectedCount -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SelectedCount -> r

gmapQ :: (forall d. Data d => d -> u) -> SelectedCount -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SelectedCount -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SelectedCount -> m SelectedCount

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SelectedCount -> m SelectedCount

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SelectedCount -> m SelectedCount

Num SelectedCount

Defined in Reflex.Query.Class

Methods

(+) :: SelectedCount -> SelectedCount -> SelectedCount

(-) :: SelectedCount -> SelectedCount -> SelectedCount

(*) :: SelectedCount -> SelectedCount -> SelectedCount

negate :: SelectedCount -> SelectedCount

abs :: SelectedCount -> SelectedCount

signum :: SelectedCount -> SelectedCount

fromInteger :: Integer -> SelectedCount

Ord SelectedCount

Defined in Reflex.Query.Class

Methods

compare :: SelectedCount -> SelectedCount -> Ordering

(<) :: SelectedCount -> SelectedCount -> Bool

(<=) :: SelectedCount -> SelectedCount -> Bool

(>) :: SelectedCount -> SelectedCount -> Bool

(>=) :: SelectedCount -> SelectedCount -> Bool

max :: SelectedCount -> SelectedCount -> SelectedCount

min :: SelectedCount -> SelectedCount -> SelectedCount

Read SelectedCount

Defined in Reflex.Query.Class

Methods

readsPrec :: Int -> ReadS SelectedCount

readList :: ReadS [SelectedCount]

readPrec :: ReadPrec SelectedCount

readListPrec :: ReadPrec [SelectedCount]

Real SelectedCount

Defined in Reflex.Query.Class

Methods

toRational :: SelectedCount -> Rational

Show SelectedCount

Defined in Reflex.Query.Class

Methods

showsPrec :: Int -> SelectedCount -> ShowS

show :: SelectedCount -> String

showList :: [SelectedCount] -> ShowS

Ix SelectedCount

Defined in Reflex.Query.Class

Methods

range :: (SelectedCount, SelectedCount) -> [SelectedCount]

index :: (SelectedCount, SelectedCount) -> SelectedCount -> Int

unsafeIndex :: (SelectedCount, SelectedCount) -> SelectedCount -> Int

inRange :: (SelectedCount, SelectedCount) -> SelectedCount -> Bool

rangeSize :: (SelectedCount, SelectedCount) -> Int

unsafeRangeSize :: (SelectedCount, SelectedCount) -> Int

Semigroup SelectedCount

Defined in Reflex.Query.Class

Methods

(<>) :: SelectedCount -> SelectedCount -> SelectedCount

sconcat :: NonEmpty SelectedCount -> SelectedCount

stimes :: Integral b => b -> SelectedCount -> SelectedCount

Monoid SelectedCount

Defined in Reflex.Query.Class

Methods

mempty :: SelectedCount

mappend :: SelectedCount -> SelectedCount -> SelectedCount

mconcat :: [SelectedCount] -> SelectedCount

Storable SelectedCount

Defined in Reflex.Query.Class

Methods

sizeOf :: SelectedCount -> Int

alignment :: SelectedCount -> Int

peekElemOff :: Ptr SelectedCount -> Int -> IO SelectedCount

pokeElemOff :: Ptr SelectedCount -> Int -> SelectedCount -> IO ()

peekByteOff :: Ptr b -> Int -> IO SelectedCount

pokeByteOff :: Ptr b -> Int -> SelectedCount -> IO ()

peek :: Ptr SelectedCount -> IO SelectedCount

poke :: Ptr SelectedCount -> SelectedCount -> IO ()

Bits SelectedCount

Defined in Reflex.Query.Class

Methods

(.&.) :: SelectedCount -> SelectedCount -> SelectedCount

(.|.) :: SelectedCount -> SelectedCount -> SelectedCount

xor :: SelectedCount -> SelectedCount -> SelectedCount

complement :: SelectedCount -> SelectedCount

shift :: SelectedCount -> Int -> SelectedCount

rotate :: SelectedCount -> Int -> SelectedCount

zeroBits :: SelectedCount

bit :: Int -> SelectedCount

setBit :: SelectedCount -> Int -> SelectedCount

clearBit :: SelectedCount -> Int -> SelectedCount

complementBit :: SelectedCount -> Int -> SelectedCount

testBit :: SelectedCount -> Int -> Bool

bitSizeMaybe :: SelectedCount -> Maybe Int

bitSize :: SelectedCount -> Int

isSigned :: SelectedCount -> Bool

shiftL :: SelectedCount -> Int -> SelectedCount

unsafeShiftL :: SelectedCount -> Int -> SelectedCount

shiftR :: SelectedCount -> Int -> SelectedCount

unsafeShiftR :: SelectedCount -> Int -> SelectedCount

rotateL :: SelectedCount -> Int -> SelectedCount

rotateR :: SelectedCount -> Int -> SelectedCount

popCount :: SelectedCount -> Int

FiniteBits SelectedCount

Defined in Reflex.Query.Class

Methods

finiteBitSize :: SelectedCount -> Int

countLeadingZeros :: SelectedCount -> Int

countTrailingZeros :: SelectedCount -> Int

Commutative SelectedCount

Defined in Reflex.Query.Class

Group SelectedCount

Defined in Reflex.Query.Class

Methods

negateG :: SelectedCount -> SelectedCount

(~~) :: SelectedCount -> SelectedCount -> SelectedCount

combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount

The Semigroup/Monoid/Group instances for a Query containing SelectedCounts should use this function which returns Nothing if the result is 0. This allows the pruning of leaves of the Query that are no longer wanted.

class (Group q, Commutative q, Query q, Monad m) => MonadQuery t q m | m -> q t where

A class that allows sending of Querys and retrieval of QueryResults. See queryDyn for a commonly used interface.

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()

askQueryResult :: m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))

Instances

MonadQuery t q m => MonadQuery t q (ReaderT r m)

Defined in Reflex.Query.Class

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> ReaderT r m ()

askQueryResult :: ReaderT r m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> ReaderT r m (Dynamic t (QueryResult q))

(MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m)

Defined in Reflex.EventWriter.Base

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> EventWriterT t w m ()

askQueryResult :: EventWriterT t w m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> EventWriterT t w m (Dynamic t (QueryResult q))

(Monad m, Group q, Commutative q, Query q, Reflex t) => MonadQuery t q (QueryT t q m)

Defined in Reflex.Query.Base

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> QueryT t q m ()

askQueryResult :: QueryT t q m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> QueryT t q m (Dynamic t (QueryResult q))

(MonadQuery t q m, Monad m) => MonadQuery t q (DynamicWriterT t w m)

Defined in Reflex.DynamicWriter.Base

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> DynamicWriterT t w m ()

askQueryResult :: DynamicWriterT t w m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> DynamicWriterT t w m (Dynamic t (QueryResult q))

(MonadQuery t q m, Monad m) => MonadQuery t q (BehaviorWriterT t w m)

Defined in Reflex.BehaviorWriter.Base

Methods

tellQueryIncremental :: Incremental t (AdditivePatch q) -> BehaviorWriterT t w m ()

askQueryResult :: BehaviorWriterT t w m (Dynamic t (QueryResult q))

queryIncremental :: Incremental t (AdditivePatch q) -> BehaviorWriterT t w m (Dynamic t (QueryResult q))

MonadQuery t q m => MonadQuery (ProfiledTimeline t) q (ProfiledM m)

Defined in Reflex.Profiled

Methods

tellQueryIncremental :: Incremental (ProfiledTimeline t) (AdditivePatch q) -> ProfiledM m ()

askQueryResult :: ProfiledM m (Dynamic (ProfiledTimeline t) (QueryResult q))

queryIncremental :: Incremental (ProfiledTimeline t) (AdditivePatch q) -> ProfiledM m (Dynamic (ProfiledTimeline t) (QueryResult q))

tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()

Produce and send an Incremental Query from a Dynamic Query.

queryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))

Retrieve Dynamically updating QueryResults for a Dynamically updating Query.

subQuery :: (Reflex t, MonadQuery t q2 m) => QueryMorphism q1 q2 -> Dynamic t q1 -> m (Dynamic t (QueryResult q1))

Use a query morphism to operate on a smaller version of a query.

mapQuery :: QueryMorphism q q' -> q -> q'

Apply a QueryMorphism to a Query

mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q

Map a QueryMorphism to a QueryResult