2025-11-03 18:19:12 +00:00
|
|
|
# Changelog
|
|
|
|
|
|
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
|
|
|
|
|
|
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
|
|
|
|
|
|
|
|
|
|
## [Unreleased]
|
2025-11-03 18:41:28 +00:00
|
|
|
### Added
|
|
|
|
|
- pkg.go.dev Examples: `ExampleNewKDTreeFromDim_Insert`, `ExampleKDTree_TiesBehavior`, `ExampleKDTree_Radius_none`.
|
|
|
|
|
- Lint: enable `errcheck` in `.golangci.yml` with test-file exclusion to reduce noise.
|
|
|
|
|
- CI: enable module cache in `actions/setup-go` to speed up workflows.
|
2025-11-03 18:36:09 +00:00
|
|
|
|
|
|
|
|
## [0.2.1] - 2025-11-03
|
2025-11-03 18:19:12 +00:00
|
|
|
### Added
|
2025-11-03 18:36:09 +00:00
|
|
|
- Normalization stats helpers: `AxisStats`, `NormStats`, `ComputeNormStats2D/3D/4D`.
|
|
|
|
|
- Builders that reuse stats: `Build2DWithStats`, `Build3DWithStats`, `Build4DWithStats`.
|
|
|
|
|
- pkg.go.dev examples: `ExampleBuild2DWithStats`, `ExampleBuild4DWithStats`.
|
|
|
|
|
- Tests for stats parity, min==max safety, and dynamic update with reused stats.
|
|
|
|
|
- Docs: API reference section “KDTree Normalization Stats (reuse across updates)”; updated multi-dimensional docs with WithStats snippet.
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Bumped version to `0.2.1`.
|
|
|
|
|
|
|
|
|
|
### Previously added in Unreleased
|
2025-11-03 18:19:12 +00:00
|
|
|
- README badges (pkg.go.dev, CI, Go Report Card, govulncheck) and KDTree performance/concurrency notes.
|
|
|
|
|
- Examples directory with runnable programs: 1D ping, 2D ping+hop, 3D ping+hop+geo, 4D ping+hop+geo+score.
|
|
|
|
|
- CI workflow (Go 1.22/1.23): tidy check, build, vet, test -race, build examples, govulncheck, golangci-lint.
|
|
|
|
|
- Lint configuration (.golangci.yml) with a pragmatic ruleset.
|
|
|
|
|
- Contributor docs: CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md.
|
|
|
|
|
- pkg.go.dev example functions for KDTree usage and helpers.
|
2025-11-03 18:36:09 +00:00
|
|
|
- Fuzz tests and benchmarks for KDTree (Nearest/KNearest/Radius and metrics).
|
2025-11-03 18:19:12 +00:00
|
|
|
|
|
|
|
|
## [0.2.0] - 2025-10-??
|
|
|
|
|
### Added
|
|
|
|
|
- KDTree public API with generic payloads and helper builders (Build2D/3D/4D).
|
|
|
|
|
- Docs pages for DHT examples and multi-dimensional KDTree usage.
|
|
|
|
|
|
2025-11-03 18:36:09 +00:00
|
|
|
[Unreleased]: https://github.com/Snider/Poindexter/compare/v0.2.1...HEAD
|
|
|
|
|
[0.2.1]: https://github.com/Snider/Poindexter/releases/tag/v0.2.1
|
2025-11-03 18:19:12 +00:00
|
|
|
[0.2.0]: https://github.com/Snider/Poindexter/releases/tag/v0.2.0
|
