Hasklepias.Types.Feature

Types

data Show b => FeatureSpec b f e a d

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

FeatureSpec

Fields

• getSpecName :: Text
• getSpecAttr :: b
• getDefn :: FeatureDefinition f e a d

data Show b => Feature b d

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

Constructors

Feature

Fields

• getName :: Text
• getAttr :: b
• getData :: FeatureData d

Instances

(Show b, ToJSON b, ToJSON d) => ToJSON (Feature b d)

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

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

Constructors

FeatureData

Fields

• getFeatureData :: Either MissingReason d

Instances

Functor FeatureData

Defined in Hasklepias.Types.Feature

Methods

fmap :: (a -> b) -> FeatureData a -> FeatureData b

(<$) :: a -> FeatureData b -> FeatureData a

Eq d => Eq (FeatureData d)

Defined in Hasklepias.Types.Feature

Methods

(==) :: FeatureData d -> FeatureData d -> Bool

(/=) :: FeatureData d -> FeatureData d -> Bool

Show d => Show (FeatureData d)

Defined in Hasklepias.Types.Feature

Methods

showsPrec :: Int -> FeatureData d -> ShowS

show :: FeatureData d -> String

showList :: [FeatureData d] -> ShowS

Generic (FeatureData d)

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)

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)

Defined in Hasklepias.Types.Feature

type Rep (FeatureData d) = D1 ('MetaData "FeatureData" "Hasklepias.Types.Feature" "hasklepias-0.5.0-inplace" 'True) (C1 ('MetaCons "FeatureData" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFeatureData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either MissingReason d))))

data MissingReason

A Feature may be missing for any number of reasons.

Constructors

InsufficientData

Excluded

Other Text

Unknown

Instances

Eq MissingReason

Defined in Hasklepias.Types.Feature

Methods

(==) :: MissingReason -> MissingReason -> Bool

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

Read MissingReason

Defined in Hasklepias.Types.Feature

Methods

readsPrec :: Int -> ReadS MissingReason

readList :: ReadS [MissingReason]

readPrec :: ReadPrec MissingReason

readListPrec :: ReadPrec [MissingReason]

Show MissingReason

Defined in Hasklepias.Types.Feature

Methods

showsPrec :: Int -> MissingReason -> ShowS

show :: MissingReason -> String

showList :: [MissingReason] -> ShowS

Generic MissingReason

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

Defined in Hasklepias.Types.Feature.Aeson

Methods

toJSON :: MissingReason -> Value

toEncoding :: MissingReason -> Encoding

toJSONList :: [MissingReason] -> Value

toEncodingList :: [MissingReason] -> Encoding

type Rep MissingReason

Defined in Hasklepias.Types.Feature

type Rep MissingReason = D1 ('MetaData "MissingReason" "Hasklepias.Types.Feature" "hasklepias-0.5.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 a d

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

Constructors

EF (Events a -> FeatureData d)

FEF (FeatureData e -> Events a -> FeatureData d)

FFF (FeatureData f -> FeatureData e -> FeatureData d)

defineEF

Arguments

:: Intervallic Interval a

=> MissingReason

The reason if f returns Nothing

-> (Events a -> Maybe c)

A function that maps events to an some intermediary Maybe type. In the case that this function returns Nothing, you get a Left FeatureData with the provided MissingReason. Otherwise, the Just result is passed to the next function for final transformation to the desired Feature type.

-> (c -> d)

A function that transforms the intermediary data to the desired type.

-> FeatureDefinition * e a d

Define an EF FeatureDefinition

defineFEF

Arguments

:: Intervallic Interval a

=> MissingReason

The reason if the input Feature is a Left.

-> (e -> Events a -> d)

A function that tranforms the data of a Right input Feature and a collection of events into the desired type.

-> FeatureDefinition * e a d

TODO

defineFEF2

Arguments

:: Intervallic Interval a

=> MissingReason

The reason if the input Feature is a Left.

-> (e -> Events a -> FeatureData d)

A function that tranforms the data of a Right input Feature and a collection of events into the desired type.

-> FeatureDefinition * e a d

TODO

defineFFF :: MissingReason -> MissingReason -> (f -> e -> d) -> FeatureDefinition f e * d

TODO

applyEF :: FeatureDefinition * * a d -> Events a -> FeatureData d

Extract an EF FeatureDefinition.

applyFEF :: FeatureDefinition * e a d -> FeatureData e -> Events a -> FeatureData d

Extract a FEF FeatureDefinition

applyFFF :: FeatureDefinition f e * d -> FeatureData f -> FeatureData e -> FeatureData d

Extract a FFF FeatureDefinition

featureR :: d -> FeatureData d

Create the Right side of a Feature.

featureL :: MissingReason -> FeatureData d

Create the Left side of a Feature.

evalEFFeature :: Show b => FeatureSpec b * * a d -> Events a -> Feature b d

TODO

evalFEFFeature :: Show b => FeatureSpec b * e a d -> Feature b e -> Events a -> Feature b d

TODO

evalFFFFeature :: Show b => FeatureSpec b f e * d -> Feature b f -> Feature b e -> Feature b d

TODO