Snider/Poindexter
1
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Poindexter/CHANGELOG.md

2.7 KiB
Raw Blame History

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

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.

[0.3.0] - 2025-11-03

Added

  • New distance metrics: CosineDistance and WeightedCosineDistance (1 - cosine similarity), with robust zero-vector handling and bounds.
  • N-D normalization helpers: ComputeNormStatsND, BuildND, BuildNDWithStats for arbitrary dimensions, with validation errors (ErrInvalidFeatures, ErrInvalidWeights, ErrInvalidInvert, ErrStatsDimMismatch).
  • Tests: unit tests for cosine/weighted-cosine metrics; parity tests between Build4D and BuildND; error-path tests; extended fuzz to include cosine metrics.
  • pkg.go.dev examples: ExampleBuildND, ExampleBuildNDWithStats, ExampleCosineDistance.

Changed

  • Version bumped to 0.3.0.
  • README: list Cosine among supported metrics.

0.2.1 - 2025-11-03

Added

  • 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

  • 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.
  • Fuzz tests and benchmarks for KDTree (Nearest/KNearest/Radius and metrics).

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.