ac

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2017 License: BSD-3-Clause Imports: 1 Imported by: 0

README

ac

GoDoc Build Status

Golang implementation of Aho-Corasick for rapid substring matching on byte strings.

This is based on the excellent library cloudflare/ahocorasick (BSD License). The fork/changes were needed for a specific application usages that are incomptabile with the original library.

Examples

  • FindAllString
m := ac.MustCompileString([]string{"Superman", "uperman", "perman", "erman"})
matches := m.FindAllString("The Man Of Steel: Superman")
fmt.Println(matches)

Output:

[Superman uperman perman erman]
  • MatchString
m := ac.MustCompileString([]string{"Superman", "uperman", "perman", "erman"})
contains := m.MatchString("The Man Of Steel: Superman")
fmt.Println(contains)

Output:

true

NOTES

  • This is designed for ASCII pattern matching at the byte level. There is no rune support, no UTF-8 support (other than the ASCII subset).
  • Similar API to regexp package.
  • Byte and String-based API work the same. Again, there is no UTF-8 support.

IN PROGRESS

  • Current API allows for overlapping matches. This is slow and potentially exponential and is different than how golang's regular expressions work. This will be changed.
  • Support for ASCII case-insensitive matching.

Documentation

Overview

Package ac provides an implementation of the Aho-Corasick string matching algorithm. Throughout this code []byte is referred to as a blice.

http://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_string_matching_algorithm

Copyright (c) 2013 CloudFlare, Inc.

Originally from https://github.com/cloudflare/ahocorasick

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Matcher

type Matcher struct {
	// contains filtered or unexported fields
}

Matcher contains a list of blices to match against

func Compile

func Compile(dictionary [][]byte) (*Matcher, error)

Compile creates a new Matcher using a list of []byte

func CompileString

func CompileString(dictionary []string) (*Matcher, error)

CompileString creates a new Matcher used to match against a set of strings (this is a helper to make initialization easy)

func MustCompile

func MustCompile(dictionary [][]byte) *Matcher

MustCompile returns a Matcher or panics

func MustCompileString

func MustCompileString(dictionary []string) *Matcher

MustCompileString returns a Matcher or panics

func (*Matcher) FindAll

func (m *Matcher) FindAll(in []byte) [][]byte

FindAll searches in for blices and returns all the blices found in the original dictionary

func (*Matcher) FindAllString

func (m *Matcher) FindAllString(in string) []string

FindAllString searches in for blices and returns all the blices (as strings) found as in the original dictionary

Example
m := MustCompileString([]string{"Superman", "uperman", "perman", "erman"})
matches := m.FindAllString("The Man Of Steel: Superman")
fmt.Println(matches)
Output:
[Superman uperman perman erman]

func (*Matcher) Match

func (m *Matcher) Match(in []byte) bool

Match returns true if the input slice contains any subslices

func (*Matcher) MatchString

func (m *Matcher) MatchString(in string) bool

MatchString returns true if the input slice contains any subslices

Example
m := MustCompileString([]string{"Superman", "uperman", "perman", "erman"})
contains := m.MatchString("The Man Of Steel: Superman")
fmt.Println(contains)
Output:
true

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL