easy_complex 0.3.2

Easy to use complex number arithmetics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# easy-complex
[![Github build](https://img.shields.io/badge/build-passing-brightgreen.svg)]()
[![GitHub package version](https://img.shields.io/badge/crates.io-0.3.1-orange.svg)](https://crates.io/crates/easy_complex)
[![Github license](https://img.shields.io/badge/license-apache-blue.svg)](https://github.com/spcan/easy-complex/blob/master/LICENSE)

easy-complex is a no-dependencies crate that provides easy to use complex number operations and provides an explicit cast for all numeric types in the standard library.

[Github repo](https://github.com/spcan/easy-complex)

[crates.io page](https://crates.io/crates/easy_complex)

## Features

  - Explicit cast from integers, unsigned integers and floats to Exponential Complex Number (ExpComplex).
  - Easy operations with overloaded standard operators.
  - Automatic conversion to the leftmost type of complex in operations.
  - A custom Display trait implementation that prints in either exponential form or coordinate form.

## Installation
easy complex doesn't have any dependencies except the standard library.
Just add to your ```Cargo.toml```

```
[dependencies]
easy_complex = "0.3.2"
```
If you don't use or want to use cargo, the crate can be found in this [crates.io](https://crates.io/crates/easy_complex) page

Versions before 0.3.1 have some errors, misspells and/or overcomplicated ways, their use is not recommended.


## Usage
For extensive explanation and usage go to the [wiki](https://github.com/spcan/easy-complex/wiki)

To use the complex numbers do
```
use easy_complex::{ExpComplex, NumComplex};
```

To use the explicit conversion do
```
use easy_complex::ContainedInComplex;
```

 >This is based on the Real domain, which is contained within the Complex domain in Math

 >Warning!!! Values near zero may diverge in the argument if used in ExpComplex form

## TODO
 - ~~Implement destructuring for the complex numbers as well as assigning from tuples~~
 - Some advanced functions on the complex domain (**C**)
 - Clean up and more extensive documentation

## LICENSE
Apache License 2.0