splines/README.md

27 lines
1.3 KiB
Markdown
Raw Normal View History

# splines
This crate provides [splines](https://en.wikipedia.org/wiki/Spline_(mathematics)), mathematic curves
defined piecewise through control keys a.k.a. knots.
Feel free to dig in the [online documentation](https://docs.rs/splines) for further information.
## A note on features
This crate has features! Heres a comprehensive list of what you can enable:
2018-08-09 01:23:45 +02:00
- **Serialization / deserialization.**
2018-10-13 03:31:44 +02:00
+ This feature implements both the `Serialize` and `Deserialize` traits from `serde` for all
types exported by this crate.
2018-08-09 01:23:45 +02:00
+ Enable with the `"serialization"` feature.
2018-10-13 03:31:44 +02:00
- **[cgmath](https://crates.io/crates/cgmath) implementors.**
+ Adds some useful implementations of `Interpolate` for some cgmath types.
+ Enable with the `"impl-cgmath"` feature.
2018-10-13 03:31:44 +02:00
- **[nalgebra](https://crates.io/crates/nalgebra) implementors.**
+ Adds some useful implementations of `Interpolate` for some nalgebra types.
+ Enable with the `"impl-nalgebra"` feature.
2018-09-30 16:38:59 +02:00
- **Standard library / no standard library.**
2018-08-09 01:23:45 +02:00
+ Its possible to compile against the standard library or go on your own without it.
+ Compiling with the standard library is enabled by default.
2018-09-30 16:38:59 +02:00
+ Use `default-features = []` in your `Cargo.toml` to disable.
+ Enable explicitly with the `"std"` feature.