Hasklepias.Types.Feature

Types

newtype Feature d

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

Constructors

Feature

Fields

• getFeature :: Either MissingReason d

Instances

Functor Feature

Defined in Hasklepias.Types.Feature

Methods

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

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

Eq d => Eq (Feature d)

Defined in Hasklepias.Types.Feature

Methods

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

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

Show d => Show (Feature d)

Defined in Hasklepias.Types.Feature

Methods

showsPrec :: Int -> Feature d -> ShowS

show :: Feature d -> String

showList :: [Feature d] -> ShowS

Generic (Feature d)

Defined in Hasklepias.Types.Feature

Associated Types

type Rep (Feature d) :: Type -> Type

Methods

from :: Feature d -> Rep (Feature d) x

to :: Rep (Feature d) x -> Feature d

ToJSON d => ToJSON (Feature d)

Defined in Hasklepias.Types.Feature.Aeson

Methods

toJSON :: Feature d -> Value

toEncoding :: Feature d -> Encoding

toJSONList :: [Feature d] -> Value

toEncodingList :: [Feature d] -> Encoding

type Rep (Feature d)

Defined in Hasklepias.Types.Feature

type Rep (Feature d) = D1 ('MetaData "Feature" "Hasklepias.Types.Feature" "hasklepias-0.4.3-6vKfYAsEvQiGredrPyh3Vx" 'True) (C1 ('MetaCons "Feature" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFeature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either MissingReason d))))

data MissingReason

A Feature may be missing for any number of reasons.

Constructors

InsufficientData

Excluded

Other String

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.4.3-6vKfYAsEvQiGredrPyh3Vx" '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 String)) :+: C1 ('MetaCons "Unknown" 'PrefixI 'False) (U1 :: Type -> Type)))

data FeatureDefinition e a d

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

Constructors

EF (Events a -> Feature d)

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

applyEF :: FeatureDefinition e a d -> Events a -> Feature d

Extract an EF FeatureDefinition.

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 feature 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

defineFEF2

Arguments

:: Intervallic Interval a

=> MissingReason

The reason if the input Feature is a Left.

-> (e -> Events a -> Feature 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

applyFEF :: FeatureDefinition e a d -> Feature e -> Events a -> Feature d

Extract a FEF FeatureDefinition

featureR :: d -> Feature d

Create the Right side of a Feature.

featureL :: MissingReason -> Feature d

Create the Left side of a Feature.