package bytealg

Import Path
	internal/bytealg (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 10 packages

Involved Source Files

	    bytealg.go
	    compare_native.go
	    count_native.go
	    equal_generic.go
	    equal_native.go
	    index_amd64.go
	    index_native.go
	    indexbyte_native.go
	    lastindexbyte_generic.go
	    compare_amd64.s
	    count_amd64.s
	    equal_amd64.s
	    index_amd64.s
	    indexbyte_amd64.s
Package-Level Functions (total 16)

	 func Compare(a, b []byte) int
	 func Count(b []byte, c byte) int
	 func CountString(s string, c byte) int
	 func Cutover(n int) int
		Cutover reports the number of failures of IndexByte we should tolerate
		before switching over to Index.
		n is the number of bytes processed so far.
		See the bytes.Index implementation for details.

	 func Equal(a, b []byte) bool
		Equal reports whether a and b
		are the same length and contain the same bytes.
		A nil argument is equivalent to an empty slice.
		
		Equal is equivalent to bytes.Equal.
		It is provided here for convenience,
		because some packages cannot depend on bytes.

	 func HashStr[T](sep T) (uint32, uint32)

		Type Parameters:
			T: string | []byte

		HashStr returns the hash and the appropriate multiplicative
		factor for use in Rabin-Karp algorithm.

	 func HashStrRev[T](sep T) (uint32, uint32)

		Type Parameters:
			T: string | []byte

		HashStrRev returns the hash of the reverse of sep and the
		appropriate multiplicative factor for use in Rabin-Karp algorithm.

	 func Index(a, b []byte) int
		Index returns the index of the first instance of b in a, or -1 if b is not present in a.
		Requires 2 <= len(b) <= MaxLen.

	 func IndexByte(b []byte, c byte) int
	 func IndexByteString(s string, c byte) int
	 func IndexRabinKarp[T](s, sep T) int

		Type Parameters:
			T: string | []byte

		IndexRabinKarp uses the Rabin-Karp search algorithm to return the index of the
		first occurrence of sep in s, or -1 if not present.

	 func IndexString(a, b string) int
		IndexString returns the index of the first instance of b in a, or -1 if b is not present in a.
		Requires 2 <= len(b) <= MaxLen.

	 func LastIndexByte(s []byte, c byte) int
	 func LastIndexByteString(s string, c byte) int
	 func LastIndexRabinKarp[T](s, sep T) int

		Type Parameters:
			T: string | []byte

		LastIndexRabinKarp uses the Rabin-Karp search algorithm to return the last index of the
		occurrence of sep in s, or -1 if not present.

	 func MakeNoZero(n int) []byte
		MakeNoZero makes a slice of length and capacity n without zeroing the bytes.
		It is the caller's responsibility to ensure uninitialized bytes
		do not leak to the end user.


Package-Level Variables (only one)

	  var MaxLen int
		MaxLen is the maximum length of the string to be searched for (argument b) in Index.
		If MaxLen is not 0, make sure MaxLen >= 4.


Package-Level Constants (total 2)

	const MaxBruteForce = 64
	const PrimeRK = 16777619
		PrimeRK is the prime base used in Rabin-Karp algorithm.

The pages are generated with Golds v0.6.9-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.