Data.FMIndex

Full-text Minute-space index (FM-index)

Users will get the most mileage by first compressing to a BWT on the initial ByteString or Text input before compressing to a FMIndexB or FMIndexT.

To do this, users can use the bytestringToBWTToFMIndexB and bytestringToBWTToFMIndexT functions, as well as the textToBWTToFMIndexB and textToBWTToFMIndexT functions.

The base functions for ByteString, bytestringToFMIndexB and bytestringToFMIndexT can be used to convert a Seq (Maybe ByteString) to a FMIndexB and FMIndexT, respectively.

Likewise, the base functions for Text, textToFMIndexB and textToFMIndexT can be used to convert a Seq (Maybe Text) to a FMIndexB and FMIndexT respectively.

There are various other lower-level functions for interacting with the FMIndex implementation on ByteString and Text as well.

Operation: Count

The count operation on ByteString, bytestringFMIndexCount, is implemented using the countFMIndexB function.

The count operation on Text, textFMIndexCount, is implemented using the countFMIndexT function.

Operation: Locate

The locate operation on ByteString, bytestringFMIndexLocate, is implemented using the locateFMIndexB function.

The locate operation on Text, textFMIndexLocate, is implemented using the locateFMIndexT function.

Internal

Data.FMIndex.Internal contains efficient and stateful implementations of the FMIndex and Inverse FMIndex algorithms.

To FMIndex functions

bytestringToBWTToFMIndexB :: ByteString -> FMIndexB

Helper function for converting a ByteString to a FMIndexB via a BWT first.

bytestringToBWTToFMIndexT :: ByteString -> FMIndexT

Helper function for converting a ByteString to a FMIndexT via a BWT first.

textToBWTToFMIndexB :: Text -> FMIndexB

Helper function for converting a Text to a FMIndexB via a BWT first.

textToBWTToFMIndexT :: Text -> FMIndexT

Helper function for converting a Text to a FMIndexT via a BWT first.

textBWTToFMIndexB :: BWTMatrix Word8 -> TextBWT -> FMIndexB

Take a BWT of Word8s and generate the FM-index (FMIndexB).

bytestringBWTToFMIndexB :: BWTMatrix Word8 -> BWT Word8 -> FMIndexB

Take a BWT of Word8s and generate the FM-index (FMIndexB).

textBWTToFMIndexT :: BWTMatrix Word8 -> TextBWT -> FMIndexT

Take a BWT of Word8s and generate the FM-index (FMIndexB).

bytestringBWTToFMIndexT :: BWTMatrix Word8 -> BWT Word8 -> FMIndexT

Take a BWT of Word8s and generate the FM-index (FMIndexT).

textToFMIndexB :: BWTMatrix Text -> Seq (Maybe Text) -> FMIndexB

Takes a Text and returns the FM-index (FMIndexB).

bytestringToFMIndexB :: BWTMatrix ByteString -> Seq (Maybe ByteString) -> FMIndexB

Takes a Seq of ByteStrings and returns the FM-index (FMIndexB).

textToFMIndexT :: BWTMatrix Text -> Seq (Maybe Text) -> FMIndexT

Takes a Text and returns the FM-index (FMIndexT).

bytestringToFMIndexT :: BWTMatrix ByteString -> Seq (Maybe ByteString) -> FMIndexT

Takes a ByteString and returns the FM-index (FMIndexT).

From FMIndex functions

bytestringFromBWTFromFMIndexB :: FMIndexB -> ByteString

Helper function for converting a BWTed FMIndexB back to the original ByteString.

bytestringFromBWTFromFMIndexT :: FMIndexT -> ByteString

Helper function for converting a BWTed FMIndexT back to the original ByteString.

textFromBWTFromFMIndexB :: FMIndexB -> Text

Helper function for converting a BWTed FMIndexB back to the original Text.

textFromBWTFromFMIndexT :: FMIndexT -> Text

Helper function for converting a BWTed FMIndexT back to the original Text.

textBWTFromFMIndexT :: FMIndexT -> BWT Text

Takes a FMIndexT and returns the BWT of Texts.

bytestringBWTFromFMIndexT :: FMIndexT -> BWT ByteString

Takes a FMIndexT and returns the BWT of ByteStrings.

textBWTFromFMIndexB :: FMIndexB -> BWT Text

Takes a FMIndexB and returns the BWT of Texts.

bytestringBWTFromFMIndexB :: FMIndexB -> BWT ByteString

Take a FMIndexB and returns the BWT of ByteStrings.

textFromFMIndexB :: FMIndexB -> Seq (Maybe Text)

Takes a FMIndexB and returns the original Seq of Texts.

bytestringFromFMIndexB :: FMIndexB -> Seq (Maybe ByteString)

Takes a FMIndexB and returns the original Seq of ByteStrings.

textFromFMIndexT :: FMIndexT -> Seq (Maybe Text)

Takes a FMIndexT and returns the original Seq of Texts.

bytestringFromFMIndexT :: FMIndexT -> Seq (Maybe ByteString)

Takes a FMIndexT and returns the original Seq of ByteStrings.

Count operations

bytestringFMIndexCount :: [ByteString] -> ByteString -> Seq (ByteString, CIntB)

Takes a list of pattern(s) of ByteStrings and an input ByteString and returns the number of occurences of the pattern(s) in the input ByteString.

textFMIndexCount :: [Text] -> Text -> Seq (Text, CIntT)

Takes a list of pattern(s) of Texts and an input Text and returns the number of occurences of the pattern(s) in the input Text.

Locate operations

bytestringFMIndexLocate :: [ByteString] -> ByteString -> Seq (ByteString, LIntB)

Takes a list of pattern(s) of ByteStrings and an input ByteString and returns the indexe(s) of occurences of the pattern(s) in the input ByteString. The output indices are 1-based, and are not sorted.

textFMIndexLocate :: [Text] -> Text -> Seq (Text, LIntT)

Takes a list of pattern(s) of Texts and an input Text and returns the indexe(s) of occurences of the pattern(s) in the input Text. The output indices are 1-based, and are not sorted.