Skip to content

Commit 1f4f651

Browse files
committed
Update CHANGELOG
1 parent 9d194b4 commit 1f4f651

5 files changed

Lines changed: 19 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -666,4 +666,4 @@ Combine with `max_stale_generations` to trigger phase transitions automatically
666666
7. **`target_population_size` defaults to 0.** Always set it for Evolve.
667667
8. **Custom Crossover/Mutate/Extension must call `chromosome.reset_metadata(genotype.genes_hashing)`** after modifying genes directly.
668668
9. **Custom Crossover must call `state.population.increment_age()`** on existing chromosomes.
669-
10. **For deterministic tests:** use `.with_rng_seed_from_u64(0)`.
669+
10. **For deterministic tests:** use `.with_rng_seed_from_u64(0)`. Exact results may change between library versions, but deterministic within a version.

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
8+
## [0.26.1] - 2026-02-16
9+
10+
### Added
11+
* Documentation additions for AI agent (and human) consumption:
12+
* Added AGENTS.md as a comprehensive agent guide (decision matrices, API reference, copy-paste templates, gotchas)
13+
* Added docstrings to all previously undocumented public constructors and key methods
14+
* Fixed several inaccurate docstrings (extensions, crossover, mutate, select)
15+
* Improved error messages with actionable fix suggestions
16+
* Add example headers
17+
* Add a new Heterogeneous Genotype example (`examples/evolve_heterogeneous`)
18+
719
## [0.26.0] - 2025-11-24
820

921
> [!CAUTION]

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,8 @@ Run with `cargo run --example [EXAMPLE_BASENAME] --release`
136136
* See [examples/visualize_evolve_mutation_types](../main/examples/visualize_evolve_mutation_types.rs) for Evolve strategy
137137
* See [examples/visualize_permutate_mutation_types](../main/examples/visualize_permutate_mutation_types.rs) for Permutate strategy
138138
* Generates visualizations showing exploration patterns of different mutation strategies
139+
* Heterogeneous Genotype example (bool, options, continues and discrete in one genome)
140+
* See [examples/evolve_heterogeneous](../main/examples/evolve_heterogeneous.rs)
139141
* Use superset StrategyBuilder for easier switching in implementation
140142
* See [examples/explore_strategies](../main/examples/explore_strategies.rs)
141143
* Use fitness LRU cache
@@ -232,6 +234,7 @@ Default configuration for correctness AND performance
232234
Run tests with `cargo test`
233235

234236
Use `.with_rng_seed_from_u64(0)` builder step to create deterministic tests results.
237+
Exact results may change between library versions (even minor), but deterministic within a version.
235238

236239
## Benchmarks
237240
Implemented using criterion. Run benchmarks with `cargo bench`

src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
//! ## Tests
7373
//!
7474
//! Use `.with_rng_seed_from_u64(0)` builder step to create deterministic tests results.
75+
//! Exact results may change between library versions (even minor), but deterministic within a version.
7576
//!
7677
//! ## Examples
7778
//!
@@ -101,6 +102,8 @@
101102
//! * See [examples/visualize_evolve_mutation_types](https://github.com/basvanwesting/genetic-algorithm/blob/main/examples/visualize_evolve_mutation_types.rs)
102103
//! * See [examples/visualize_permutate_mutation_types](https://github.com/basvanwesting/genetic-algorithm/blob/main/examples/visualize_permutate_mutation_types.rs)
103104
//! * Generates visualizations showing exploration patterns of different mutation strategies
105+
//! * Heterogeneous Genotype example (bool, options, continues and discrete in one genome)
106+
//! * See [examples/evolve_heterogeneous](https://github.com/basvanwesting/genetic-algorithm/blob/main/examples/evolve_heterogeneous.rs)
104107
//! * Use superset StrategyBuilder for easier switching in implementation
105108
//! * See [examples/explore_strategies](https://github.com/basvanwesting/genetic-algorithm/blob/main/examples/explore_strategies.rs)
106109
//! * Use fitness LRU cache

0 commit comments

Comments
 (0)