Header menu logo BioFSharp

CP Module

A collection of Rabin-Karp string matching algorithms using the cyclic polynomial (CP) hash

Functions and values

Function or value Description

addToHashValue hs inchar

Full Usage: addToHashValue hs inchar

Parameters:
    hs : uint64
    inchar : ^a

Returns: uint64
Modifiers: inline
Type parameters: ^a

adds a hashvalue to an existing hashvalue

hs : uint64
inchar : ^a
Returns: uint64

blockHash pattern

Full Usage: blockHash pattern

Parameters:
    pattern : ^a array

Returns: uint64
Modifiers: inline
Type parameters: ^a

hashes a pattern

pattern : ^a array
Returns: uint64

find pattern s

Full Usage: find pattern s

Parameters:
    pattern : ^a array
    s : ^a array

Returns: int
Modifiers: inline
Type parameters: ^a

find the first match of a query pattern in a source

pattern : ^a array
s : ^a array
Returns: int

findAll pattern s

Full Usage: findAll pattern s

Parameters:
    pattern : ^a array
    s : ^a array

Returns: int list
Modifiers: inline
Type parameters: ^a

find all matches of a query pattern in a source

pattern : ^a array
s : ^a array
Returns: int list

findFrom startPos pattern s

Full Usage: findFrom startPos pattern s

Parameters:
    startPos : int
    pattern : ^a array
    s : ^a array

Returns: int
Modifiers: inline
Type parameters: ^a

find the first match of a query pattern in a source starting from a specific position in the source

startPos : int
pattern : ^a array
s : ^a array
Returns: int

rotateLeft r x

Full Usage: rotateLeft r x

Parameters:
    r : int32
    x : ^a

Returns: ^a
Modifiers: inline
Type parameters: ^a

bitwise cyclic rotation of a 64 bit pattern

r : int32
x : ^a
Returns: ^a

updateHash pLength hs inchar outchar

Full Usage: updateHash pLength hs inchar outchar

Parameters:
    pLength : int32
    hs : uint64
    inchar : ^a
    outchar : ^b

Returns: uint64
Modifiers: inline
Type parameters: ^a, ^b

updates an existing hashvalue

pLength : int32
hs : uint64
inchar : ^a
outchar : ^b
Returns: uint64

Type something to start searching.