Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mackysoft committed Feb 2, 2022
1 parent 084882a commit 4f2d144
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 1 deletion.
54 changes: 54 additions & 0 deletions Documentation/changelog/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.2.2] - 2021-08-03
### Removed
- Removed `WeightedSelectMethodTests.CompareAllMethod`.

### Changed
- `AliasWeightedSelectMethod` is now an internal sealed class.
- In `WeightedSelectMethodTests`, `XXX_ReturnValidValue_0` and `XXX_ReturnValidValue_1` now test with `IsNotNull` instead of `AreSame`.
- The weights of items generated by the `ItemEnumerableGenerator` now include 0.

### Fixed
- Fixed `IndexOutOfRangeException` being thrown when all weights passed to `AliasWeightedSelectMethod` are the same.

## [1.2.1] - 2021-07-31
### Added
- Added `WeightedSelectMethodSpeedTests`.

### Changed
- Optimized the setup of `AliasWeightedSelectMethod`.

## [1.2.0] - 2021-07-30
### Added
- Added alias method and tests.
- This is a very effective algorithm for selecting multiple items.

## [1.1.0] - 2021-05-17
### Added
- Added `IWeightedSelectMethod.Calculate` method.
- This allows the results of the pre-calculation to be cached, resulting in improved performance.
- Added `CompareAllMethods` test.
- All implemented `IWeightedSelectMethod`s must return the same result.

## [1.0.0] - 2021-02-01
### Added
- Added the `IWeightedSelector<T>` and `WeightedSelector<T>`.
- Added an unit tests.

### Changes
- Renamed the `ToReadOnlyWeightedSelector` method to `ToWeightedSelector`.
- Renamed the `SelectItem` method that used `UnityEngine.Random.value` to `SelectItemWithUnityRandom`.
- All WeightedSelectMethods now support weights less than or equal to 0.
- IWeightedSelectMethod now takes a TemporaryArray<float> as an argument instead of a float[].

### Fixes
- Fixed a fatal bug that prevented BinaryWeightedSelectMethod from working.

## [0.1.0] - 2021-01-19
First release
2 changes: 2 additions & 0 deletions Documentation/changelog/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Changelog
href: CHANGELOG.md
8 changes: 8 additions & 0 deletions Documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@
"*.yml"
],
"dest": "api"
},
{
"src": "changelog",
"files": [
"toc.yml",
"*.md"
],
"dest": "changelog"
}
],
"overwrite": [
Expand Down
4 changes: 3 additions & 1 deletion Documentation/toc.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
- name: Scripting API
href: api/
href: api/
- name: Changelog
href: changelog/

0 comments on commit 4f2d144

Please sign in to comment.