@@ -208,36 +341,32 @@ ctest --test-dir build --output-on-failure
Patternia gap map across key scenarios. Each row is normalized to the fastest implementation in that scenario.
-See [Performance Notes](https://patternia.tech/performance/) for full reports and methodology. - -## Performance-Oriented Usage - -Cache the case pack for repeated hot paths: - -```cpp -using namespace ptn; - -int fast_classify(int x) { - return match(x) | PTN_ON( - val<1> >> 1, - val<2> >> 2, - _ >> 0 - ); -} -``` - -`PTN_ON(...)` is a convenience wrapper over `static_on(...)`. -It avoids rebuilding the matcher object on every call. +See the [Performance Notes](https://patternia.tech/performance/) for full +reports, methodology, and per-version results, and the +[Performance Tuning guide](https://patternia.tech/guide/performance-tuning/) +for hot-path advice. ## Documentation - [Getting Started](https://patternia.tech/guide/getting-started/) +- [Installation](https://patternia.tech/guide/installation/) - [API Reference](https://patternia.tech/api/) - [Design Overview](https://patternia.tech/design-overview/) - [Tutorials](https://patternia.tech/tutorials/from-control-flow/) - [Performance Notes](https://patternia.tech/performance/) +- [Release Notes](https://patternia.tech/changelog/releases/) +- [Samples](samples/) ## Contributing -Please read [CONTRIBUTING.md](CONTRIBUTING.md) before sending changes. -This project is governed by [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). +Bug reports, feature proposals, and pull requests are welcome. Please read +[CONTRIBUTING.md](CONTRIBUTING.md) first: `main` is protected, pull +requests carry a single Conventional Commits commit, and formatting is +checked with `clang-format`. Coding agents should also read +[AGENTS.md](AGENTS.md). This project is governed by the +[Code of Conduct](CODE_OF_CONDUCT.md); report security issues as described +in [SECURITY.md](SECURITY.md). + +## License + +Patternia is released under the [MIT License](LICENSE). diff --git a/docs/index.md b/docs/index.md index 5756331..311ab3f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,9 +34,19 @@ Patternia is a modern C++ pattern-matching DSL designed to make dispatch logic c ## System Requirements -- **C++ Standard**: C++17 or later -- **Compilers**: GCC >= 11, Clang >= 12, MSVC >= 2019 -- **Platforms**: Linux, Windows, macOS +- **C++ Standard**: C++17 or later (floating-point `val