Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/david-livadaru/dlangle

Provides an abstraction for mathematical angle written in Swift 4.
https://github.com/david-livadaru/dlangle

angle carthage cross-platform swift-4 swift-package-manager swift4

Last synced: 3 days ago
JSON representation

Provides an abstraction for mathematical angle written in Swift 4.

Host: GitHub
URL: https://github.com/david-livadaru/dlangle
Owner: david-livadaru
License: mit
Created: 2017-02-18T12:16:05.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-03-25T10:22:19.000Z (over 6 years ago)
Last Synced: 2024-03-15T15:21:37.216Z (7 months ago)
Topics: angle, carthage, cross-platform, swift-4, swift-package-manager, swift4
Language: Swift
Homepage:
Size: 222 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


![DLAngle Logo](DLAngleLogo.png)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![CocoaPods compatible](https://img.shields.io/badge/CocoaPods-compatible-4BC51D.svg?style=flat)](https://github.com/CocoaPods/CocoaPods)

[![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange.svg?style=flat)](https://swift.org/package-manager/)

[![Swift 4.0](https://img.shields.io/badge/Swift_4.0-compatible-orange.svg?style=flat)](https://swift.org)

	



Provides an abstraction for mathematical angle.

Because the angle is a type, errors such as:

* sum or subtract a degree angle with a radian angle

* pass degree angle to a trigonometric function from standard library

are either not possible or catched at compile time.

Support convenience initializers, operators and functions for natural, fast and productive workflow.

## Table of contents

- [Usage](https://github.com/davidlivadaru/DLAngle#usage)

	- [Importing the module](https://github.com/davidlivadaru/DLAngle#importing-the-module)

	- [Creation](https://github.com/davidlivadaru/DLAngle#creation)

	- [Converting between Degree and Radian](https://github.com/davidlivadaru/DLAngle#converting-between-degree-and-radian)

	- [Basic Operations](https://github.com/davidlivadaru/DLAngle#basic-operations)

	- [Normalization](https://github.com/davidlivadaru/DLAngle#normalization)

	- [Equality](https://github.com/davidlivadaru/DLAngle#equality)

	- [Comparison](https://github.com/davidlivadaru/DLAngle#comparison)

	- [Foundation.Measurement conversion](https://github.com/davidlivadaru/DLAngle#foundationmeasurement-conversion)

	- [Inverse trigonometric functions](https://github.com/davidlivadaru/DLAngle#inverse-trigonometric-functions)

	- [Trigonometric functions](https://github.com/davidlivadaru/DLAngle#trigonometric-functions)

	- [Constants](https://github.com/davidlivadaru/DLAngle#constants)

- [Installation](https://github.com/davidlivadaru/DLAngle#installation)

	- [Supported Operating Systems](https://github.com/davidlivadaru/DLAngle#supported-operating-systems)

	- [Carthage](https://github.com/davidlivadaru/DLAngle#1-carthage)

	- [CocoaPods](https://github.com/davidlivadaru/DLAngle#2-cocoapods)

	- [Swift Package Manager](https://github.com/davidlivadaru/DLAngle#3-swift-package-manager)

- [Contribution](https://github.com/davidlivadaru/DLAngle#contribution)

- [License](https://github.com/davidlivadaru/DLAngle#license)

## Usage

### Importing the module

You can import this module using:

```swift

import DLAngle

```

### Creation

```swift

let degree = Degree(rawValue: 90.0)

let zeroDegrees = Degree()

let radian = Radian(rawValue: Double.pi / 2)

let zeroRadians = Radian()

```

### Converting between Degree and Radian

From Degree to Radian:

```swift

let degree = Degree(rawValue: 90.0)

let radian = Radian(degree: degree)

```

From Radian to Degree:

```swift

let radian = Radian(rawValue: Double.pi)

let degree = Degree(radian: radian)

```

### Basic Operations

Addition

```swift

let radian = Radian(degrees: 90.0)

radian += Radian(degress: 45.0)

// radian.rawValue = 3 * Double.pi / 4

```

Subtraction

```swift

var degrees = Degree(radians: Double.pi / 2)

degrees = degrees - Degree(radians: Double.pi / 6)

// degrees.rawValue = 60.0

```

Multiplcation

```swift

let half = Radian(rawValue: Double.pi / 2)

let pi = one * 2 

// '2 * one' works as well

```

Division

```swift

let pi = Radian(rawValue: Double.pi)

let sixtyDegreesRadian = one / 3 

// '1 / pi' works as well

```

### Normalization

```swift

let degree = Degree(rawValue: 750.0)

degree.normalize()

// degree.rawValue = 30.0

let angle1 = Radian(rawvalue: 7 * Double.pi)

let angle2 = angle1.normalized()

// angle2.rawValue = Double.pi

```

### Equality

```swift

let angle1 = Radian(rawValue: Double.pi)

let angle2 = Radian(degrees: 180.0)

angle1 == angle2 // true

```

### Comparison

```swift

let angle1 = Radian(rawValue: Double.pi)

let angle2 = Radian(degrees: 90.0)

angle1 < angle2 // false

```

### Foundation.Measurement conversion

```swift

let angleMeasurement = Measurement(value: 45.0, unit: .degrees)

let radian = Radian(measurement: angleMeasurement)

radian.measurement // Measurement(value: Double.pi / 4, unit: .radians)

let degrees = Degrees(measurement: angleMeasurement)

degrees.measurement // Measurement(value: 45.0, unit: .degrees)

```

### Inverse trigonometric functions

Inverse functions are provided by using convenience constructors of Radian type.

```swift

do {

   let angle = try Radian(acos: -1.0)

} catch {

   // handle error

}

```

### Trigonometric functions

```swift

let angle = Radian(degrees: 45.0)

if let sin: Double = try? angle.sin() {

   // use computed sine value

}

```

### Constants

Frequently used Radian angles have constants:

```swift

let pi = Radian.pi

let half_quadrant_II = Radian.pi_2 + Radian.pi_4

```

## Installation

### Supported Operating Systems

* **macOS** 10.12 and later

* **iOS** 10.0 and later

* **watchOS** 3.0 and later

* **tvOS** 10.0 and later

* **Ubuntu** - check [official site](https://swift.org/download/#releases) to find which versions support Swift 4.0.

### 1. [Carthage](https://github.com/Carthage/Carthage)

```

github "davidlivadaru/DLAngle"

```

If you need the framework only for a single OS, then I propose to use `--platform [iOS|macOS|watchOS|tvOS]` specifier when your perform `carthage update`.

### 2. [CocoaPods](https://github.com/CocoaPods/CocoaPods)

Add the dependency in your `Podfile`.

```

pod 'DLAngle'

```

### 3. [Swift Package Manager](https://swift.org/package-manager/)

Add the the following dependecy in your [`Package.swift`]((https://swift.org/package-manager/#example-usage)):

```

dependencies: [

    .package(url: "https://github.com/davidlivadaru/DLAngle.git", .upToNextMajor(from: "1.0.0"))

]

```

and update your target's dependencies: 

```

targets: [

        .target(

            name: "YourTargetName",

            dependencies: ["DLAngle"])),

    ]

```

## Contribution

Module is covered by unit tests, however, bugs always slip through.

If you find a bug in the module create an [issue](https://github.com/davidlivadaru/DLAngle/issues).

If you want to contribute on fixing bugs or implementing new features then create a [pull request](https://github.com/davidlivadaru/DLAngle/pulls).

## License

**DLAngle** is released under MIT license. See [LICENSE](LICENSE) for details.