charset-0.3.11: Fast unicode character sets based on complemented PATRICIA tries

Copyright | (c) Edward Kmett 2010-2011
License | BSD3
Maintainer | ekmett@gmail.com
Stability | experimental
Portability | portable
Safe Haskell | Trustworthy
Language | Haskell2010

Data.CharSet

Contents

- Set type
- Operators
- Query
- Construction
- Combine
- Filter
- Map
- Fold
- Conversion
  - List
  - Ordered list
  - IntMaps
  - Array

Description

A CharSet is an efficient representation of a set of `Char` values designed for fast membership tests.

As an example `build isAlpha` will create a set of alphabetic characters. We can then use `member` on the generated set to efficiently test if a given `Char` represents an alphabetic character.

Designed to be imported qualified:

    import Data.CharSet (CharSet)
    import qualified Data.CharSet as CharSet

Synopsis

- data CharSet = CharSet !Bool !ByteSet !IntSet
- (\\) :: CharSet -> CharSet -> CharSet
- null :: CharSet -> Bool
- size :: CharSet -> Int
- member :: Char -> CharSet -> Bool
- notMember :: Char -> CharSet -> Bool
- overlaps :: CharSet -> CharSet -> Bool
- isSubsetOf :: CharSet -> CharSet -> Bool
- isComplemented :: CharSet -> Bool
- build :: (Char -> Bool) -> CharSet
- empty :: CharSet
- singleton :: Char -> CharSet
- full :: CharSet
- insert :: Char -> CharSet -> CharSet
- delete :: Char -> CharSet -> CharSet
- complement :: CharSet -> CharSet
- range :: Char -> Char -> CharSet
- union :: CharSet -> CharSet -> CharSet
- intersection :: CharSet -> CharSet -> CharSet
- difference :: CharSet -> CharSet -> CharSet
- filter :: (Char -> Bool) -> CharSet -> CharSet
- partition :: (Char -> Bool) -> CharSet -> (CharSet, CharSet)
- map :: (Char -> Char) -> CharSet -> CharSet
- fold :: (Char -> b -> b) -> b -> CharSet -> b
- toList :: CharSet -> String
- fromList :: String -> CharSet
- toAscList :: CharSet -> String
- fromAscList :: String -> CharSet
- fromDistinctAscList :: String -> CharSet
- fromCharSet :: CharSet -> (Bool, IntSet)
- toCharSet :: IntSet -> CharSet
- toArray :: CharSet -> UArray Char Bool

# Set type

data CharSet #

Stored as a (possibly negated) IntSet and a fast set used for the head byte.

The set of valid (possibly negated) head bytes is stored unboxed as a 32-byte bytestring-based lookup table.

Constructors

CharSet !Bool !ByteSet !IntSet |

#### Instances

Instances details

Monoid CharSet # |
Instance details Defined in Data.CharSet Methods mempty :: CharSet # mappend :: CharSet -> CharSet -> CharSet # mconcat :: [CharSet] -> CharSet #
Semigroup CharSet # |
Instance details Defined in Data.CharSet Methods (<>) :: CharSet -> CharSet -> CharSet # sconcat :: NonEmpty CharSet -> CharSet # stimes :: Integral b => b -> CharSet -> CharSet #
Data CharSet # |
Instance details Defined in Data.CharSet Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CharSet -> c CharSet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CharSet # toConstr :: CharSet -> Constr # dataTypeOf :: CharSet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CharSet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CharSet) # gmapT :: (forall b. Data b => b -> b) -> CharSet -> CharSet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CharSet -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CharSet -> r # gmapQ :: (forall d. Data d => d -> u) -> CharSet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CharSet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CharSet -> m CharSet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CharSet -> m CharSet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CharSet -> m CharSet #
IsString CharSet # |
    = CharSet.fromList
Instance details Defined in Data.CharSet Methods fromString :: String -> CharSet #
Bounded CharSet # |
Instance details Defined in Data.CharSet Methods minBound :: CharSet # maxBound :: CharSet #
Read CharSet # |
Instance details Defined in Data.CharSet Methods readsPrec :: Int -> ReadS CharSet # readList :: ReadS [CharSet] # readPrec :: ReadPrec CharSet # readListPrec :: ReadPrec [CharSet] #
Show CharSet # |
Instance details Defined in Data.CharSet Methods showsPrec :: Int -> CharSet -> ShowS # show :: CharSet -> String # showList :: [CharSet] -> ShowS #
Eq CharSet # |
Instance details Defined in Data.CharSet Methods (==) :: CharSet -> CharSet -> Bool # (/=) :: CharSet -> CharSet -> Bool #
Ord CharSet # |
Instance details Defined in Data.CharSet Methods compare :: CharSet -> CharSet -> Ordering # (<) :: CharSet -> CharSet -> Bool # (<=) :: CharSet -> CharSet -> Bool # (>) :: CharSet -> CharSet -> Bool # (>=) :: CharSet -> CharSet -> Bool # max :: CharSet -> CharSet -> CharSet # min :: CharSet -> CharSet -> CharSet #

# Operators

(\\) :: CharSet -> CharSet -> CharSet #

# Query

null :: CharSet -> Bool #

O(n) worst case

size :: CharSet -> Int #

O(n)

member :: Char -> CharSet -> Bool #

notMember :: Char -> CharSet -> Bool #

overlaps :: CharSet -> CharSet -> Bool #

isSubsetOf :: CharSet -> CharSet -> Bool #

isComplemented :: CharSet -> Bool #

# Construction

build :: (Char -> Bool) -> CharSet #

Applies a predicate across the whole range of possible character values to create a set of only those characters which satisfy the predicate.

As an example `build isAlpha` will generate a CharSet of all alphabetic characters.

empty :: CharSet #

singleton :: Char -> CharSet #

full :: CharSet #

insert :: Char -> CharSet -> CharSet #

delete :: Char -> CharSet -> CharSet #

complement :: CharSet -> CharSet #

range :: Char -> Char -> CharSet #

# Combine

union :: CharSet -> CharSet -> CharSet #

intersection :: CharSet -> CharSet -> CharSet #

difference :: CharSet -> CharSet -> CharSet #

# Filter

filter :: (Char -> Bool) -> CharSet -> CharSet #

partition :: (Char -> Bool) -> CharSet -> (CharSet, CharSet) #

# Map

map :: (Char -> Char) -> CharSet -> CharSet #

# Fold

fold :: (Char -> b -> b) -> b -> CharSet -> b #

# Conversion

## List

toList :: CharSet -> String #

fromList :: String -> CharSet #

## Ordered list

toAscList :: CharSet -> String #

fromAscList :: String -> CharSet #

fromDistinctAscList :: String -> CharSet #

## IntMaps

fromCharSet :: CharSet -> (Bool, IntSet) #

toCharSet :: IntSet -> CharSet #

## Array

toArray :: CharSet -> UArray Char Bool #