Copyright	(c) NoviSci Inc 2020
License	BSD3
Maintainer	bsaul@novisci.com
Safe Haskell	Safe
Language	Haskell2010

Hasklepias.Types.Feature

Contents

Types

Description

Synopsis

data Show b => FeatureSpec b f e d = MkFeatureSpec {
- getSpecName :: Text
- getSpecAttr :: b
- getDefn :: FeatureDefinition f e d
}
data Show b => Feature b d = MkFeature {
- getName :: Text
- getAttr :: b
- getData :: FeatureData d
}
newtype FeatureData d = MkFeatureData {
- getFeatureData :: Either MissingReason d
}
data MissingReason
- = InsufficientData
- | Excluded
- | Other Text
- | Unknown
data FeatureDefinition f e d
- = FD0 (e -> FeatureData d)
- | FD1 (FeatureData e -> FeatureData d)
- | FD2 (FeatureData f -> FeatureData e -> FeatureData d)
makeFeatureSpec :: Show b => Text -> b -> FeatureDefinition f e d -> FeatureSpec b f e d
featureDataR :: d -> FeatureData d
featureDataL :: MissingReason -> FeatureData d
define0 :: (e -> FeatureData d) -> FeatureDefinition * e d
define1 :: (e -> d) -> FeatureDefinition * e d
define2 :: (f -> e -> d) -> FeatureDefinition f e d
define2d :: (f -> e -> FeatureData d) -> FeatureDefinition f e d
eval0 :: FeatureDefinition * e d -> e -> FeatureData d
eval1 :: FeatureDefinition * e d -> FeatureData e -> FeatureData d
eval2 :: FeatureDefinition f e d -> FeatureData f -> FeatureData e -> FeatureData d
evalSpec0 :: Show b => FeatureSpec b * e d -> e -> Feature b d
evalSpec1 :: Show b => FeatureSpec b * e d -> Feature b e -> Feature b d
evalSpec2 :: Show b => FeatureSpec b f e d -> Feature b f -> Feature b e -> Feature b d

Types

data Show b => FeatureSpec b f e d Source #

A FeatureSpec contains all the information needed to derive a Feature: * its name * its attributes * the function needed to derive a feature (i.e. the FeatureDefinition)

Constructors

MkFeatureSpec
Fields getSpecName :: Text getSpecAttr :: b getDefn :: FeatureDefinition f e d

data Show b => Feature b d Source #

A Feature contains the following: * a name * its attributes * FeatureData

Constructors

MkFeature
Fields getName :: Text getAttr :: b getData :: FeatureData d

Instances

Instances details

Show b => Functor (Feature b) Source #
Instance details Defined in Hasklepias.Types.Feature Methods fmap :: (a -> b0) -> Feature b a -> Feature b b0 # (<$) :: a -> Feature b b0 -> Feature b a #
(Show b, Eq b, Eq d) => Eq (Feature b d) Source #
Instance details Defined in Hasklepias.Types.Feature Methods (==) :: Feature b d -> Feature b d -> Bool # (/=) :: Feature b d -> Feature b d -> Bool #
(Show b, Show d) => Show (Feature d b) Source #
Instance details Defined in Hasklepias.Types.Feature Methods showsPrec :: Int -> Feature d b -> ShowS # show :: Feature d b -> String # showList :: [Feature d b] -> ShowS #
(Show b, ToJSON b, ToJSON d) => ToJSON (Feature b d) Source #
Instance details Defined in Hasklepias.Types.Feature.Aeson Methods toJSON :: Feature b d -> Value # toEncoding :: Feature b d -> Encoding # toJSONList :: [Feature b d] -> Value # toEncodingList :: [Feature b d] -> Encoding #

newtype FeatureData d Source #

FeatureData is Either MissingReason d, where d can be any type of data derivable from Events.

Constructors

MkFeatureData
Fields getFeatureData :: Either MissingReason d

Instances

Instances details

Monad FeatureData Source #
Instance details Defined in Hasklepias.Types.Feature Methods (>>=) :: FeatureData a -> (a -> FeatureData b) -> FeatureData b # (>>) :: FeatureData a -> FeatureData b -> FeatureData b # return :: a -> FeatureData a #
Functor FeatureData Source #
Instance details Defined in Hasklepias.Types.Feature Methods fmap :: (a -> b) -> FeatureData a -> FeatureData b # (<$) :: a -> FeatureData b -> FeatureData a #
Applicative FeatureData Source #
Instance details Defined in Hasklepias.Types.Feature Methods pure :: a -> FeatureData a # (<>) :: FeatureData (a -> b) -> FeatureData a -> FeatureData b # liftA2 :: (a -> b -> c) -> FeatureData a -> FeatureData b -> FeatureData c # (>) :: FeatureData a -> FeatureData b -> FeatureData b # (<*) :: FeatureData a -> FeatureData b -> FeatureData a #
Eq d => Eq (FeatureData d) Source #
Instance details Defined in Hasklepias.Types.Feature Methods (==) :: FeatureData d -> FeatureData d -> Bool # (/=) :: FeatureData d -> FeatureData d -> Bool #
Show d => Show (FeatureData d) Source #
Instance details Defined in Hasklepias.Types.Feature Methods showsPrec :: Int -> FeatureData d -> ShowS # show :: FeatureData d -> String # showList :: [FeatureData d] -> ShowS #
Generic (FeatureData d) Source #
Instance details Defined in Hasklepias.Types.Feature Associated Types type Rep (FeatureData d) :: Type -> Type # Methods from :: FeatureData d -> Rep (FeatureData d) x # to :: Rep (FeatureData d) x -> FeatureData d #
ToJSON d => ToJSON (FeatureData d) Source #
Instance details Defined in Hasklepias.Types.Feature.Aeson Methods toJSON :: FeatureData d -> Value # toEncoding :: FeatureData d -> Encoding # toJSONList :: [FeatureData d] -> Value # toEncodingList :: [FeatureData d] -> Encoding #
type Rep (FeatureData d) Source #
Instance details Defined in Hasklepias.Types.Feature type Rep (FeatureData d) = D1 ('MetaData "FeatureData" "Hasklepias.Types.Feature" "hasklepias-0.7.0-inplace" 'True) (C1 ('MetaCons "MkFeatureData" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFeatureData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either MissingReason d))))

data MissingReason Source #

FeatureData may be missing for any number of reasons.

Constructors

InsufficientData
Excluded
Other Text
Unknown

Instances

Instances details

Eq MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature Methods (==) :: MissingReason -> MissingReason -> Bool # (/=) :: MissingReason -> MissingReason -> Bool #
Read MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature Methods readsPrec :: Int -> ReadS MissingReason # readList :: ReadS [MissingReason] # readPrec :: ReadPrec MissingReason # readListPrec :: ReadPrec [MissingReason] #
Show MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature Methods showsPrec :: Int -> MissingReason -> ShowS # show :: MissingReason -> String # showList :: [MissingReason] -> ShowS #
Generic MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature Associated Types type Rep MissingReason :: Type -> Type # Methods from :: MissingReason -> Rep MissingReason x # to :: Rep MissingReason x -> MissingReason #
ToJSON MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature.Aeson Methods toJSON :: MissingReason -> Value # toEncoding :: MissingReason -> Encoding # toJSONList :: [MissingReason] -> Value # toEncodingList :: [MissingReason] -> Encoding #
type Rep MissingReason Source #
Instance details Defined in Hasklepias.Types.Feature type Rep MissingReason = D1 ('MetaData "MissingReason" "Hasklepias.Types.Feature" "hasklepias-0.7.0-inplace" 'False) ((C1 ('MetaCons "InsufficientData" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Excluded" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Other" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Unknown" 'PrefixI 'False) (U1 :: Type -> Type)))

data FeatureDefinition f e d Source #

A type to hold FeatureData definitions; i.e. functions that return features.

Constructors

FD0 (e -> FeatureData d)
FD1 (FeatureData e -> FeatureData d)
FD2 (FeatureData f -> FeatureData e -> FeatureData d)

makeFeatureSpec :: Show b => Text -> b -> FeatureDefinition f e d -> FeatureSpec b f e d Source #

TODO

featureDataR :: d -> FeatureData d Source #

Create the Right side of FeatureData.

featureDataL :: MissingReason -> FeatureData d Source #

Create the Left side of FeatureData.

define0 :: (e -> FeatureData d) -> FeatureDefinition * e d Source #

define1 :: (e -> d) -> FeatureDefinition * e d Source #

define2 :: (f -> e -> d) -> FeatureDefinition f e d Source #

define2d :: (f -> e -> FeatureData d) -> FeatureDefinition f e d Source #

eval0 :: FeatureDefinition * e d -> e -> FeatureData d Source #

eval1 :: FeatureDefinition * e d -> FeatureData e -> FeatureData d Source #

eval2 :: FeatureDefinition f e d -> FeatureData f -> FeatureData e -> FeatureData d Source #

evalSpec0 :: Show b => FeatureSpec b * e d -> e -> Feature b d Source #

evalSpec1 :: Show b => FeatureSpec b * e d -> Feature b e -> Feature b d Source #

evalSpec2 :: Show b => FeatureSpec b f e d -> Feature b f -> Feature b e -> Feature b d Source #