package bytealg

Import Path
	internal/bytealg (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 7 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
	      compare_amd64.s
	      count_amd64.s
	      equal_amd64.s
	      index_amd64.s
	      indexbyte_amd64.s
Package-Level Functions (total 21, in which 15 are exported)

	 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(sep string) (uint32, uint32)
		HashStr returns the hash and the appropriate multiplicative
		factor for use in Rabin-Karp algorithm.

	 func HashStrBytes(sep []byte) (uint32, uint32)
		HashStrBytes returns the hash and the appropriate multiplicative
		factor for use in Rabin-Karp algorithm.

	 func HashStrRev(sep string) (uint32, uint32)
		HashStrRev returns the hash of the reverse of sep and the
		appropriate multiplicative factor for use in Rabin-Karp algorithm.

	 func HashStrRevBytes(sep []byte) (uint32, uint32)
		HashStrRevBytes 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(s, substr string) int
		IndexRabinKarp uses the Rabin-Karp search algorithm to return the index of the
		first occurrence of substr in s, or -1 if not present.

	 func IndexRabinKarpBytes(s, sep []byte) int
		IndexRabinKarpBytes uses the Rabin-Karp search algorithm to return the index of the
		first occurrence of substr 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.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	 func abigen_runtime_cmpstring(a, b string) int
	 func abigen_runtime_memequal(a, b unsafe.Pointer, size uintptr) bool
	 func abigen_runtime_memequal_varlen(a, b unsafe.Pointer) bool
	 func countGeneric(b []byte, c byte) int
		A backup implementation to use by assembly.

	 func countGenericString(s string, c byte) int
	 func init()
Package-Level Variables (only one, which is exported)

	  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 7, in which 2 are exported)

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

	/* 5 unexporteds ... *//* 5 unexporteds: */
	const offsetS390xHasVX uintptr = 80
		Offsets into internal/cpu records for use in assembly.

	const offsetX86HasAVX2 uintptr = 67
		Offsets into internal/cpu records for use in assembly.

	const offsetX86HasPOPCNT uintptr = 74
		Offsets into internal/cpu records for use in assembly.

	const offsetX86HasSSE2 uintptr = 75
		Offsets into internal/cpu records for use in assembly.

	const offsetX86HasSSE42 uintptr = 79
		Offsets into internal/cpu records for use in assembly.

The pages are generated with Golds v0.4.2. (GOOS=darwin 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.