package guts

Import Path
	lukechampine.com/blake3/guts (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 2 packages

Involved Source Files

	    compress_amd64.go
	    compress_generic.go
	    cpu.go
	  d node.go
		Package guts provides a low-level interface to the BLAKE3 cryptographic hash
		function.

	    compress_amd64.s
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Node (struct)
		A Node represents a chunk or parent in the BLAKE3 Merkle tree.

		Fields (total 5)
			Block [16]uint32
			BlockLen uint32
			CV [8]uint32
				// chaining value from previous node

			Counter uint64
			Flags uint32
		As Outputs Of (at least 4)
			func CompressBuffer(buf *[16384]byte, buflen int, key *[8]uint32, counter uint64, flags uint32) Node
			func CompressChunk(chunk []byte, key *[8]uint32, counter uint64, flags uint32) Node
			func CompressEigentree(buf []byte, key *[8]uint32, counter uint64, flags uint32) Node
			func ParentNode(left, right [8]uint32, key *[8]uint32, flags uint32) Node
		As Inputs Of (at least 3)
			func ChainingValue(n Node) (cv [8]uint32)
			func CompressBlocks(out *[1024]byte, n Node)
			func CompressNode(n Node) (out [16]uint32)


Package-Level Functions (total 10)

	 func BytesToWords(bytes [64]byte) [16]uint32
		BytesToWords converts an array of 64 bytes to an array of 16 bytes.

	 func ChainingValue(n Node) (cv [8]uint32)
		ChainingValue compresses n and returns the first 8 output words.

	 func CompressBlocks(out *[1024]byte, n Node)
		CompressBlocks compresses MaxSIMD copies of n with successive counter values,
		storing the results in out.

	 func CompressBuffer(buf *[16384]byte, buflen int, key *[8]uint32, counter uint64, flags uint32) Node
		CompressBuffer compresses up to MaxSIMD chunks in parallel and returns their
		root node.

	 func CompressChunk(chunk []byte, key *[8]uint32, counter uint64, flags uint32) Node
		CompressChunk compresses a single chunk, returning its final (uncompressed)
		node.

	 func CompressEigentree(buf []byte, key *[8]uint32, counter uint64, flags uint32) Node
		CompressEigentree compresses a buffer of 2^n chunks in parallel, returning
		their root node.

	 func CompressNode(n Node) (out [16]uint32)
		CompressNode compresses a node into a 16-word output.

	 func Eigentrees(counter uint64, chunks uint64) (trees []int)
		Eigentrees returns the sequence of eigentree heights that increment counter
		to counter+chunks.

	 func ParentNode(left, right [8]uint32, key *[8]uint32, flags uint32) Node
		ParentNode returns a Node that incorporates the chaining values of two child
		nodes.

	 func WordsToBytes(words [16]uint32) [64]byte
		WordsToBytes converts an array of 16 words to an array of 64 bytes.


Package-Level Variables (only one)

	  var IV [8]uint32
		IV is the BLAKE3 initialization vector.


Package-Level Constants (total 10)

	const BlockSize = 64
		Various constants.

	const ChunkSize = 1024
		Various constants.

	const FlagChunkEnd = 2
		Various constants.

	const FlagChunkStart = 1
		Various constants.

	const FlagDeriveKeyContext = 32
		Various constants.

	const FlagDeriveKeyMaterial = 64
		Various constants.

	const FlagKeyedHash = 16
		Various constants.

	const FlagParent = 4
		Various constants.

	const FlagRoot = 8
		Various constants.

	const MaxSIMD = 16 // AVX-512 vectors can store 16 words
		Various constants.

The pages are generated with Golds v0.8.2. (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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.