Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JeroenGar committed Feb 21, 2024
1 parent 0fd4a42 commit 5cc8d98
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
6 changes: 4 additions & 2 deletions jagua-rs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ The docs can be build using `cargo doc --open` from the root of the repository.
## Testing

`jagua-rs` contains a suite of assertions which are enabled by default in debug builds to ensure the correctness of the engine.
These assertions are disabled in release builds to maximize performance.
These tests are sprinkled throughout the codebase and aim to check correctness of many of the datastructures.
In release builds, these assertions are disabled by default to maximize performance.

TODO: unit testing
`lbf` contains some basic integration tests (with assertions enabled) to validate the correctness of the engine on a macro level.
See [lbf crate](../lbf#Testing) for more information.
11 changes: 11 additions & 0 deletions lbf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,14 @@ Seemingly superior configurations (such as increased `n_samples_per_item`), for
Testing with `deterministic_mode` set to `false` will demonstrate this spread in solution quality.

**Once again, this heuristic should only serve as a reference implementation of how to use `jagua-rs` and not as a reliable optimization algorithm for any real-world problems.**

## Testing

`lbf` contains some basic integration tests to validate the correctness of the heuristic on a macro level. (needs to be improved and expanded)
It basically runs the heuristic on a set of input files with `debug-assertions = true`.


To run the tests, use:
```bash
cargo test -- --nocapture
```

0 comments on commit 5cc8d98

Please sign in to comment.