summaryrefslogtreecommitdiffstats
path: root/rust/vendor/num-complex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/vendor/num-complex/README.md')
-rw-r--r--rust/vendor/num-complex/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/rust/vendor/num-complex/README.md b/rust/vendor/num-complex/README.md
new file mode 100644
index 0000000..0536a2b
--- /dev/null
+++ b/rust/vendor/num-complex/README.md
@@ -0,0 +1,50 @@
+# num-complex
+
+[![crate](https://img.shields.io/crates/v/num-complex.svg)](https://crates.io/crates/num-complex)
+[![documentation](https://docs.rs/num-complex/badge.svg)](https://docs.rs/num-complex)
+![minimum rustc 1.15](https://img.shields.io/badge/rustc-1.15+-red.svg)
+[![Travis status](https://travis-ci.org/rust-num/num-complex.svg?branch=master)](https://travis-ci.org/rust-num/num-complex)
+
+`Complex` numbers for Rust.
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+num-complex = "0.2"
+```
+
+and this to your crate root:
+
+```rust
+extern crate num_complex;
+```
+
+## Features
+
+This crate can be used without the standard library (`#![no_std]`) by disabling
+the default `std` feature. Use this in `Cargo.toml`:
+
+```toml
+[dependencies.num-complex]
+version = "0.2"
+default-features = false
+```
+
+Features based on `Float` types are only available when `std` is enabled. Where
+possible, `FloatCore` is used instead. Formatting complex numbers only supports
+format width when `std` is enabled.
+
+Implementations for `i128` and `u128` are only available with Rust 1.26 and
+later. The build script automatically detects this, but you can make it
+mandatory by enabling the `i128` crate feature.
+
+## Releases
+
+Release notes are available in [RELEASES.md](RELEASES.md).
+
+## Compatibility
+
+The `num-complex` crate is tested for rustc 1.15 and greater.