Skip to content

Commit

Permalink
Polish README
Browse files Browse the repository at this point in the history
  • Loading branch information
ceandrade committed Sep 29, 2023
1 parent cbf4609 commit 5525e6c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ Supporting `run()`, we have three new methods:
- `status.best_fitness <= lower_bound * 1.1` **OR**
- `status.current_iteration == max_iterations`.

Note that BRKGA-MP-IPR always tests against time and stalled iterations to
avoid hanging up. However, this behavior can be changed by modifying the
maximum time and maximum stalled iterations in the control parameters.

| :memo: Note |
|:---------------------------|
Expand Down Expand Up @@ -214,7 +217,8 @@ Supporting `run()`, we have three new methods:
```
- `setShakingMethod()`: This method adds a custom shaking procedure defined
by the user. Please, refer to its documentation for more details.
by the user. Please,
[refer to its documentation for more details](https://ceandrade.github.io/brkga_mp_ipr_cpp/page_guide.html#providing-custom-shake-procedure).
Less important but still relevant: previously, one must call `initialize()`
before any method that manipulated the population. Also, since `initialize()`
Expand Down

0 comments on commit 5525e6c

Please sign in to comment.