Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/david-livadaru/dlinterval
A mathematical abstractions of intervals in Swift
https://github.com/david-livadaru/dlinterval
carthage cocoapods cross-platform interval math swift-package-manager swift4
Last synced: 3 days ago
JSON representation
A mathematical abstractions of intervals in Swift
- Host: GitHub
- URL: https://github.com/david-livadaru/dlinterval
- Owner: david-livadaru
- License: mit
- Created: 2017-10-19T20:45:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-21T13:26:22.000Z (over 6 years ago)
- Last Synced: 2024-03-18T20:44:43.033Z (6 months ago)
- Topics: carthage, cocoapods, cross-platform, interval, math, swift-package-manager, swift4
- Language: Swift
- Homepage:
- Size: 122 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Carthage/Carthage)
[](https://github.com/CocoaPods/CocoaPods)
[](https://swift.org/package-manager/)
[](https://swift.org)
This Swift module aims to provide a solution to easily create mathematical intervals.
## Table of contents
- [Usage](https://github.com/davidlivadaru/DLInterval#usage)
- [Importing the module](https://github.com/davidlivadaru/DLInterval#importing-the-module)
- [Creation](https://github.com/davidlivadaru/DLInterval#creation)
- [Check](https://github.com/davidlivadaru/DLInterval#check)
- [Unions](https://github.com/davidlivadaru/DLInterval#unions)
- [Intersections](https://github.com/davidlivadaru/DLInterval#intersections)
- [Clipping values](https://github.com/davidlivadaru/DLInterval#clipping-values)
- [Installation](https://github.com/davidlivadaru/DLInterval#installation)
- [Carthage](https://github.com/davidlivadaru/DLInterval#1-carthage)
- [CocoaPods](https://github.com/davidlivadaru/DLInterval#2-cocoapods)
- [Swift Package Manager](https://github.com/davidlivadaru/DLInterval#3-swift-package-manager)
- [Contribution](https://github.com/davidlivadaru/DLInterval#contribution)
- [License](https://github.com/davidlivadaru/DLInterval#license)
## Usage
### Importing the module
You can import this module using:
```swift
import DLInterval
```
### Creation
`Interval` has constructors to create intervals using the notations we're used to from mathmatics:
`[1, 2]` and `(1, 2)`
```swift
let closedClosed = Interval([1..2]) // [1, 2]
let openOpen = Interval((1..2)) // (1, 2)
```
For convenience, range operators may be used:
```swift
let closedClosed = Interval(1...2) // [1, 2]
let closedOpen = Interval(1..<2) // [1, 2)
```
For half open intervals there are some new operators:
* `.>.` - first boundary is open
* `.<.` - second boundary is open
* `.><.` - both boundaries are open
```swift
let closedOpen: Interval = 1.<.2 // [1, 2)
let openClosed: Interval = 1.>.2 // (1, 2]
let openOpen: Interval = 1.><.2 // (1, 2)
```
To create intervals with infinity as boundaries:
```swift
let negativeInfinity: Interval = -Double.infinity.>.0 // (-inf, 0]
let positiveInfinity: Interval = 0.><.Double.Infinity // (0, +inf)
```
**Note**: Creating an interval with a closed boundary using infinity is ill-formed.
### Check
You may check if an interval contains a double value:
```swift
let closedOpen: Interval = 1.<.2
closedOpen.contains(1) // true
closedOpen.contains(2) // false
closedOpen.contains(1.1) // true
```
Checking infinity values:
```swift
let closedOpen: Interval = 1.<.2
closedOpen.contains(Double.infinity) // false
closedOpen.contains(-Double.infinity) // false
let positiveInfinity: Interval = 0.><.Double.Infinity
positiveInfinity.contains(Double.infinity) // true
positiveInfinity.contains(-Double.infinity) // false
```
### Unions
Creating a union from 2 intervals:
```swift
let firstInterval: Interval = -Double.infinity.>.0 // (-inf, 0]
let secondInterval: Interval = 0.><.1 // (0, 1)
let union = firstInterval.formUnion(secondInterval) // (-inf, 1)
```
**Note**: `union` is a new data type called `UnionInterval`.
### Intersections
Find intersection of 2 intervals:
```swift
let firstInterval: Interval = -Double.infinity.><.1 // (-inf, 1)
let secondInterval: Interval = -1.><.5.0 // (-1, 5)
let intersection = firstInterval.intersection(with: secondInterval) // (-1, 1)
```
**Note**: `Interval`'s intersection returns an `Interval?` and `UnionInterval`'s returns `UnionInterval`.
### Clipping values
Available from `v1.1.1`.
An interval can clip a value within its boundaries:
```swift
let interval = Interval([0..1])
let newValue = interval.clipValue(-0.5) // 0.0
```
**Note**: Open boundaries returns the closest value to boundary:
```swift
let interval = Interval((-1..1))
let newValue = interval.clipValue(2.0) // 0.99999999
```
## Installation
Module requires Swift 4.0.
OS requirements:
- **iOS** 10.0 and later.
- **watchOS** 3.0 and later.
- **tvOS** 10.0 and later.
- **macOS** 10.12 and later.
- **Ubuntu** - check [official site](https://swift.org/download/#releases) to find which versions support Swift 4.0.
Choose your preferred dependency manager:
### 1. [Carthage](https://github.com/Carthage/Carthage)
Add the dependency in your `Cartfile`.
```
github "davidlivadaru/DLInterval"
```
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 'DLInterval'
```
### 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/DLInterval.git", .upToNextMajor(from: "1.0.0"))
]
```
and update your target's dependencies:
```
targets: [
.target(
name: "YourTargetName",
dependencies: ["DLInterval"])),
]
```
## 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/DLInterval/issues).
If you want to contribute on fixing bugs or implementing new features then create a [pull request](https://github.com/davidlivadaru/DLInterval/pulls).
## License
**DLInterval** is released under MIT license. See [LICENSE](LICENSE) for details.