https://github.com/somerandomiosdev/complex
Swift Complex Numbers
https://github.com/somerandomiosdev/complex
hacktoberfest
Last synced: 17 days ago
JSON representation
Swift Complex Numbers
- Host: GitHub
- URL: https://github.com/somerandomiosdev/complex
- Owner: SomeRandomiOSDev
- License: mit
- Created: 2020-02-14T05:33:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-20T23:50:36.000Z (about 4 years ago)
- Last Synced: 2025-10-21T07:53:12.753Z (17 days ago)
- Topics: hacktoberfest
- Language: Swift
- Homepage:
- Size: 162 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Complex
========
[](https://app.codacy.com/app/SomeRandomiOSDev/Complex?utm_source=github.com&utm_medium=referral&utm_content=SomeRandomiOSDev/Complex&utm_campaign=Badge_Grade_Dashboard)
[](https://cocoapods.org/pods/Complex)
[](https://cocoapods.org/pods/Complex)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/Complex)
[](https://codecov.io/gh/SomeRandomiOSDev/Complex)
**Complex** is a lightweight framework designed for representing and working with complex numbers for iOS, macOS, tvOS, and watchOS.
Installation
--------
**Complex** is available through [CocoaPods](https://cocoapods.org), [Carthage](https://github.com/Carthage/Carthage) and the [Swift Package Manager](https://swift.org/package-manager/).
To install via CocoaPods, simply add the following line to your Podfile:
```ruby
pod 'Complex'
```
To install via Carthage, simply add the following line to your Cartfile:
```ruby
github "SomeRandomiOSDev/Complex"
```
To install via the Swift Package Manager add the following line to your `Package.swift` file's `dependencies`:
```swift
.package(url: "https://github.com/SomeRandomiOSDev/Complex.git", from: "1.0.0")
```
Usage
--------
First import **Complex** at the top of your Swift file:
```swift
import Complex
```
After importing, use of complex numbers is as simple as can be:
```swift
let input = Complex(real: 4.31, imaginary: 2.0)
let scale = Complex(real: 1.5, imaginary: 2.718)
let output = input * scale
...
```
The **Complex** type also has builtin functionality specific to complex numbers, such as conjugates and modulus/angle (for converting to polar coordinates):
```swift
let complex = Complex(real: 7.0, imaginary: -4.1)
// Equal to 7.0 + 4.1i
let conjugate = ~complex // or complex.conjugate()
let (modulus, angle) = (complex.modulus, complex.angle)
...
```
Note
--------
The Swift library team has released their own **Complex** type as part of the Swift Numerics library. This library is likely to be archived in the future unless there is a continued need for this library to continue to be maintained. You can find more information about the new **Complex** type [here](https://swift.org/blog/numerics/#complex-numbers)
Contributing
--------
If you have need for a specific feature or you encounter a bug, please open an issue. If you extend the functionality of **Complex** yourself or you feel like fixing a bug yourself, please submit a pull request.
Author
--------
Joe Newton, somerandomiosdev@gmail.com
License
--------
**Complex** is available under the MIT license. See the `LICENSE` file for more info.