Skip to content

Commit

Permalink
Update README with the new 'nalgebral' feature
Browse files Browse the repository at this point in the history
  • Loading branch information
Maher Sallam committed Aug 14, 2020
1 parent e95ae63 commit cacf212
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ There are additional features which can be activated in `Cargo.toml`:

```toml
[dependencies]
argmin = { version = "0.3.1", features = ["ctrlc", "ndarrayl"] }
argmin = { version = "0.3.1", features = ["ctrlc", "ndarrayl", "nalgebral"] }
```

These may become default features in the future. Without these features compilation to
Expand All @@ -96,13 +96,14 @@ These may become default features in the future. Without these features compilat
- `ctrlc`: Uses the `ctrlc` crate to properly stop the optimization (and return the current best
result) after pressing Ctrl+C.
- `ndarrayl`: Support for `ndarray`, `ndarray-linalg` and `ndarray-rand`.
- `nalgebral`: Support for [`nalgebra`](https://nalgebra.org)

### Running the tests

Running the tests requires the `ndarrayl` feature to be enabled
Running the tests requires the `ndarrayl` and `nalgebral` features to be enabled

```bash
cargo test --features "ndarrayl"
cargo test --features "ndarrayl nalgebral"
```

## Defining a problem
Expand Down

0 comments on commit cacf212

Please sign in to comment.