examples/README.md

# Examples

Simple functions:

* **[add](add):** Add two numbers. The "Hello World!" of `avo`.
* **[sum](sum):** Sum an array of numbers.

Features:

* **[args](args):** Loading function arguments.
* **[returns](returns):** Building return values.
* **[complex](complex):** Working with `complex{64,128}` types.
* **[data](data):** Defining `DATA` sections.
* **[ext](ext):** Interacting with types from external packages.
* **[pragma](pragma):** Apply compiler directives to generated functions.

"Real" examples:

* **[fnv1a](fnv1a):** [FNV-1a](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function#FNV-1a_hash) hash function.
* **[dot](dot):** Vector dot product.
* **[geohash](geohash):** Integer [geohash](https://en.wikipedia.org/wiki/Geohash) encoding.
* **[md5x16](md5x16):** AVX-512 accelerated [MD5](https://en.wikipedia.org/wiki/MD5).
* **[sha1](sha1):** [SHA-1](https://en.wikipedia.org/wiki/SHA-1) cryptographic hash.
* **[stadtx](stadtx):** [`StadtX` hash](https://github.com/demerphq/BeagleHash) port from [dgryski/go-stadtx](https://github.com/dgryski/go-stadtx).
doc: README for args example Also started a README in the root examples directory. Updates #14 2019-01-01 15:46:42 -08:00			`# Examples`

doc: README for sum example Updates #14 2019-01-01 16:04:37 -08:00			`Simple functions:`
doc: README for args example Also started a README in the root examples directory. Updates #14 2019-01-01 15:46:42 -08:00
			* [add](add): Add two numbers. The "Hello World!" of `avo`.
doc: README for sum example Updates #14 2019-01-01 16:04:37 -08:00			`* [sum](sum): Sum an array of numbers.`

			`Features:`

doc: README for args example Also started a README in the root examples directory. Updates #14 2019-01-01 15:46:42 -08:00			`* [args](args): Loading function arguments.`
doc: README for returns example Updates #14 2019-01-01 16:15:33 -08:00			`* [returns](returns): Building return values.`
doc: README for complex example Updates #14 2019-01-01 15:56:17 -08:00			* [complex](complex): Working with `complex{64,128}` types.
doc: README for data example Updates #14 2019-01-01 16:33:30 -08:00			* [data](data): Defining `DATA` sections.
gotypes,build: add Implement (#58) By using Implement you can provide a definition of a function, taking the signature from a stub in the package. One major benefit of this approach is it makes it easy to handle external types in the function signature. Updates #55 2019-01-22 22:35:01 -08:00			`* [ext](ext): Interacting with types from external packages.`
ir,build: pragma support (#97) Adds support for arbitrary compiler directives. Fixes #15 2019-09-16 11:01:48 -07:00			`* [pragma](pragma): Apply compiler directives to generated functions.`
doc: READMEs for remaining "real world" examples Updates #14 2019-01-01 17:01:08 -08:00
			`"Real" examples:`

			`* [fnv1a](fnv1a): [FNV-1a](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function#FNV-1a_hash) hash function.`
			`* [dot](dot): Vector dot product.`
			`* [geohash](geohash): Integer [geohash](https://en.wikipedia.org/wiki/Geohash) encoding.`
all: AVX-512 (#217) Extends avo to support most AVX-512 instruction sets. The instruction type is extended to support suffixes. The K family of opmask registers is added to the register package, and the operand package is updated to support the new operand types. Move instruction deduction in `Load` and `Store` is extended to support KMOV* and VMOV* forms. Internal code generation packages were overhauled. Instruction database loading required various messy changes to account for the additional complexities of the AVX-512 instruction sets. The internal/api package was added to introduce a separation between instruction forms in the database, and the functions avo provides to create them. This was required since with instruction suffixes there is no longer a one-to-one mapping between instruction constructors and opcodes. AVX-512 bloated generated source code size substantially, initially increasing compilation and CI test times to an unacceptable level. Two changes were made to address this: 1. Instruction constructors in the `x86` package moved to an optab-based approach. This compiles substantially faster than the verbose code generation we had before. 2. The most verbose code-generated tests are moved under build tags and limited to a stress test mode. Stress test builds are run on schedule but not in regular CI. An example of AVX-512 accelerated 16-lane MD5 is provided to demonstrate and test the new functionality. Updates #20 #163 #229 Co-authored-by: Vaughn Iverson <vsivsi@yahoo.com> 2021-11-12 18:35:36 -08:00			`* [md5x16](md5x16): AVX-512 accelerated [MD5](https://en.wikipedia.org/wiki/MD5).`
doc: READMEs for remaining "real world" examples Updates #14 2019-01-01 17:01:08 -08:00			`* [sha1](sha1): [SHA-1](https://en.wikipedia.org/wiki/SHA-1) cryptographic hash.`
			* [stadtx](stadtx): [`StadtX` hash](https://github.com/demerphq/BeagleHash) port from [dgryski/go-stadtx](https://github.com/dgryski/go-stadtx).