Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michalkonturek/MKUnits
Unit conversion library for Swift.
https://github.com/michalkonturek/MKUnits
Last synced: about 1 month ago
JSON representation
Unit conversion library for Swift.
- Host: GitHub
- URL: https://github.com/michalkonturek/MKUnits
- Owner: michalkonturek
- License: mit
- Created: 2013-06-28T08:50:04.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-03-31T10:30:37.000Z (over 4 years ago)
- Last Synced: 2024-07-20T00:06:57.108Z (about 2 months ago)
- Language: Swift
- Homepage:
- Size: 1000 KB
- Stars: 342
- Watchers: 16
- Forks: 30
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - MKUnits - Unit conversion library for Swift. (Utility / Web View)
- awesome-ios-star - MKUnits - Unit conversion library for Swift. (Utility / Web View)
README
# MKUnits
[](http://cocoapods.org/pods/MKUnits)
[](https://travis-ci.org/michalkonturek/MKUnits)
[](http://swift.org)
[](http://cocoapods.org/pods/MKUnits)
[](http://twitter.com/michalkonturek)
MKUnits is extremely precise unit conversion library for `Swift`. It provides units of measurement of physical quantities and simplifies manipulation of them.
**NB** For `Objective-C` implementation, please refer to MKUnits pod 2.2.1 or visit [archived branch][archive-branch].
[archive-branch]:https://github.com/michalkonturek/MKUnits/tree/archive-objc
## License
MKUnits is available under the MIT license. See the [LICENSE][LICENSE] file for more info.
[LICENSE]:https://github.com/michalkonturek/MKUnits/blob/master/LICENSE
## Installation
MKUnits is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "MKUnits"
```
## Example
Let's create 1.5 kilograms **[kg]**,
```swift
let kilograms = 1.5.kilogram()
```
0.5 **[kg]** in grams **[g]**
```swift
let grams = 500.gram()
```
and 10 pounds **[lb]** (which is 4.5359237 **[kg]**)
```swift
let pounds = 10.pound()
```
Then we add all of the above togehter and subtract 0.0001 **[kg]** in milligrams **[mg]**.
```swift
let milligrams = 100.milligram()
var result = kilograms + grams + pounds - milligrams
```
The result amount is 6.5358237 **[kg]**.
Now we subtract 0.5358237 **[kg]** in ounces **[oz]**, which is 18.900624805 **[oz]** according to Google converter, but as MKUnits is very precise, it is in fact 18.900624805483390296005199558361177 **[oz]**.
```swift
let ounces = 0.5358237.kilogram().converted(MassUnit.ounce)
result = result - ounces
```
The result amount is ~6 **[kg]**; 6.00000000000000000000000000000000003 **[kg]** to be exact.
Now we want the result to be in stones **[st]**, so:
```swift
result = result.converted(MassUnit.stone)
// 0.94483873964811055873038869091017890993 st
```
As the result is too precise for our needs, we want to round it.
```swift
let rounded = result.rounded(3)
// 0.945 st
```
## Supported Units
At the moment MKUnits supports the following `group units`:
* Area (base unit: square meter)
* Mass (base unit: kilogram)
* Length (base unit: meter)
* Time (base unit: second)
* Volume (base unit: litre)
You can easily extend MKUnits by adding new [`group units`](#new-group-unit) or [`units`](#new-unit).
## Extending MKUnits
To add a new `group unit`, simply create a class that extends `Unit` and follow the convention below.
Please make sure that `unit symbols` are unique across your new `group unit`.
```swift
public final class NewUnit: Unit {
public static var unitA: NewUnit {
return NewUnit(
name: "unit A",
symbol: "uA",
ratio: NSDecimalNumber.one() // as it is a base unit
)
}
public static var unitB: NewUnit {
return NewUnit(
name: "unit B",
symbol: "uB",
ratio: NSDecimalNumber(mantissa: 2, exponent: 0, isNegative: false)
)
}
}
extension NSNumber {
public func unitA() -> Quantity {
return Quantity(amount: self, unit: NewUnit.unitA)
}
public func unitB() -> Quantity {
return Quantity(amount: self, unit: NewUnit.unitB)
}
}
```
### Adding new units to existing `group unit`
To add additional units to existing `group unit` simply create a category for that `group unit`.
Do not sublcass as units are only interconvertible with units belonging to the same `group unit`.
```swift
extension NewUnit {
public static var unitC: NewUnit {
return NewUnit(
name: "unit C",
symbol: "uC",
ratio: NSDecimalNumber(mantissa: 4, exponent: 0, isNegative: false)
)
}
}
extension NSNumber {
public func unitC() -> Quantity {
return Quantity(amount: self, unit: NewUnit.unitC)
}
}
```
## Contributing
1. Fork it.
2. Create your feature branch (`git checkout -b new-feature`).
3. Commit your changes (`git commit -am 'Added new-feature'`).
4. Push to the branch (`git push origin new-feature`).
5. Create new Pull Request.