Data.TextArray.Unboxed

This module provides the TextArray container for storing arrays of text strings.

This module is intended to be imported qualified, e.g.

import           Data.TextArray.Unboxed (TextArr)
import qualified Data.TextArray.Unboxed as TextArr

Documentation

data TextArray

An array of unboxed ShortText strings

The memory footprint of this data-structure is a single heap object (an unlifted ByteArray#) with the size expressed in words

\[ 3 + n + \left\lceil \frac{1}{w} \sum_{i=0}^{n-1} len(s_i) \right\rceil \]

where the word-size \(w\) is either \(w = 4\) or \(w = 8\) bytes; and where \(len(s_i)\) denotes the UTF-8 size in bytes of the \(i\)-th text string.

NOTE: Depending on whether you UNPACK the TextArray wrapper, you need at least one additional word for the pointer to the internal ByteArray# heap object.

Instances

IsList TextArray

Associated Types

type Item TextArray :: *

Methods

fromList :: [Item TextArray] -> TextArray

fromListN :: Int -> [Item TextArray] -> TextArray

toList :: TextArray -> [Item TextArray]

Eq TextArray

Methods

(==) :: TextArray -> TextArray -> Bool

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

Ord TextArray

Methods

compare :: TextArray -> TextArray -> Ordering

(<) :: TextArray -> TextArray -> Bool

(<=) :: TextArray -> TextArray -> Bool

(>) :: TextArray -> TextArray -> Bool

(>=) :: TextArray -> TextArray -> Bool

max :: TextArray -> TextArray -> TextArray

min :: TextArray -> TextArray -> TextArray

Read TextArray

Methods

readsPrec :: Int -> ReadS TextArray

readList :: ReadS [TextArray]

readPrec :: ReadPrec TextArray

readListPrec :: ReadPrec [TextArray]

Show TextArray

Methods

showsPrec :: Int -> TextArray -> ShowS

show :: TextArray -> String

showList :: [TextArray] -> ShowS

Semigroup TextArray

\(\mathcal{O}(n+m)\). Concatenate two TextArrays.

Methods

(<>) :: TextArray -> TextArray -> TextArray

sconcat :: NonEmpty TextArray -> TextArray

stimes :: Integral b => b -> TextArray -> TextArray

Monoid TextArray

Methods

mempty :: TextArray

mappend :: TextArray -> TextArray -> TextArray

mconcat :: [TextArray] -> TextArray

NFData TextArray

Methods

rnf :: TextArray -> ()

Hashable TextArray

Methods

hashWithSalt :: Int -> TextArray -> Int

hash :: TextArray -> Int

type Item TextArray

type Item TextArray = ShortText

Querying & lookup

null :: TextArray -> Bool

\(\mathcal{O}(1)\). Test whether TestArray is empty.

length :: TextArray -> Int

\(\mathcal{O}(1)\). Return number of strings contained in TestArray.

elem :: ShortText -> TextArray -> Bool

\(\mathcal{O}(n)\). Test whether TestArray contains a specific string.

elemIndices :: ShortText -> TextArray -> [Int]

\(\mathcal{O}(n)\). Find occurences of given string in TextArray and report list of indices (in ascending order).

(!?) :: TextArray -> Int -> Maybe ShortText

\(\mathcal{O}(1)\). Array indexing (0-based).

Construction

empty :: TextArray

\(\mathcal{O}(1)\). An empty TextArray

singleton :: ShortText -> TextArray

\(\mathcal{O}(1)\). Construct TextArray with single element

fromList :: [ShortText] -> TextArray

\(\mathcal{O}(n)\). Construct TextArray from list of strings.

Deconstruction

toList :: TextArray -> [ShortText]

\(\mathcal{O}(n)\). Deconstruct TextArray into list of strings.