RegExDot.Consumer

AUTHOR

Dr. Alistair Ward

DESCRIPTION

• Define the requirements & capabilities of a data-type which is designed to consume data.
• This module also facilitates investigation of group-behaviour, by defining operations on either concatenations or alternations of Consumers.
• This module is specifically for use in a regex-engine, in which the meta-data from which the regex is composed, are considered to consume input data, whilst concatenation & alternation of such elements, behave as a different types of groups of consumer.

Type-classes

class Consumer c where

• The interface, to which types, which have a data-requirement, may conform.
• Regrettably, methods requiring reference to the type of the consumable, would require multi-parameter type-classes.
• consumptionProfile defines the quantity-range of data which may be consumed, & any specific data-requirements.
• starHeight measures the complexity of the Consumer.

Minimal complete definition

consumptionProfile, starHeight

Methods

consumptionProfile :: c -> ConsumptionProfile

starHeight :: c -> StarHeight

Instances

Consumer c => Consumer [c]

Methods

consumptionProfile :: [c] -> ConsumptionProfile

starHeight :: [c] -> StarHeight

Consumer a => Consumer (Repeatable a)

Methods

consumptionProfile :: Repeatable a -> ConsumptionProfile

starHeight :: Repeatable a -> StarHeight

Consumer (Meta m)

Methods

consumptionProfile :: Meta m -> ConsumptionProfile

starHeight :: Meta m -> StarHeight

Consumer (ExtendedRegEx m)

Methods

consumptionProfile :: ExtendedRegEx m -> ConsumptionProfile

starHeight :: ExtendedRegEx m -> StarHeight

Consumer (Pattern m)

Methods

consumptionProfile :: Pattern m -> ConsumptionProfile

starHeight :: Pattern m -> StarHeight

Consumer (Alternatives m)

Methods

consumptionProfile :: Alternatives m -> ConsumptionProfile

starHeight :: Alternatives m -> StarHeight

Types

Type-synonyms

Functions

accumulateConsumptionProfiles :: Consumer c => [c] -> AccumulatedConsumptionProfiles

Get the ConsumptionProfile for the specified list of Consumers, then accumulate them.

aggregateConsumptionProfilesFromAlternatives :: Consumer c => [c] -> ConsumptionProfile

The aggregate of the specified alternation of ConsumptionProfiles.

aggregateConsumptionProfilesFromConcatenation :: Consumer c => [c] -> ConsumptionProfile

Get the ConsumptionProfiles for the specified list of Consumers, then find the net effect of concatenating them.

Query

getConsumptionBounds :: Consumer c => c -> ConsumptionBounds

Convenience-function, to query the ConsumptionBounds of a Consumer.

getFewest :: Consumer c => c -> DataLength

Determine the minimum acceptable quantity of data.

getHasSpecificRequirement :: Consumer c => c -> Bool

Determine whether the specified Consumer, has a specific requirement.