Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyugit/uint256
An UInt256 library written in Swift 4
https://github.com/hyugit/uint256
algo algorithm bigint biginteger carthage cocoapods divide-and-conquer ios karatsuba-multiplication macos playground swift swift-package-manager swift4 uint256
Last synced: 3 months ago
JSON representation
An UInt256 library written in Swift 4
- Host: GitHub
- URL: https://github.com/hyugit/uint256
- Owner: hyugit
- License: mit
- Created: 2017-12-30T20:45:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-01T21:42:22.000Z (over 5 years ago)
- Last Synced: 2024-10-14T22:21:41.736Z (3 months ago)
- Topics: algo, algorithm, bigint, biginteger, carthage, cocoapods, divide-and-conquer, ios, karatsuba-multiplication, macos, playground, swift, swift-package-manager, swift4, uint256
- Language: Swift
- Homepage:
- Size: 91.8 KB
- Stars: 23
- Watchers: 2
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UInt256
[](https://travis-ci.org/hyugit/UInt256)
[](https://swift.org)
[](https://github.com/hyugit/UInt256)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/)
[](https://coveralls.io/github/hyugit/UInt256)
A UInt256 library written in Swift 4, **inspired** by [CryptoCoinSwift/UInt256](https://github.com/CryptoCoinSwift/UInt256)
## Features
This library provides a UInt256 struct that conforms nicely to Swift's **FixedWidthInteger** and **UnsignedInteger** protocols. According to Apple, the two are the necessary top level protocols for an UInt member: [here](https://github.com/apple/swift-evolution/blob/master/proposals/0104-improved-integers.md#proposed-solution)
It supports a complete set of arithmetic operations, as well as properties and functions that are common to other UInt family members such as `UInt64`, `UInt32`, `UInt8`, etc. The library leverages [Karatsuba fast multiplication](https://en.wikipedia.org/wiki/Karatsuba_algorithm) algorithm, [Divide and Conquer](http://bioinfo.ict.ac.cn/~dbu/AlgorithmCourses/Lectures/Hasselstrom2003.pdf) division algorithm, [Barrett Algorithm](https://members.loria.fr/PZimmermann/mca/mca-cup-0.5.9.pdf) for division and other efficient algos for other operators. Other features include integer literal representation (`ExpressibleByIntegerLiteral`), default description (`CustomStringConvertible`) and `Hashable`.
The library is written entirely in **Swift 4**. It can be installed as a **Swift Package**, a **Carthage package** or a **CocoaPod**. And a playground is also included as a testbench.
Please feel free to submit new feature requests and report issues here on GitHub. :smiley:
### Please use the playground to try out all the features!
## Swift Protocol Conformance
The main struct UInt256 conforms strictly to the following protocols:
- **FixedWidthInteger**
- **UnsignedInteger**
- **BinaryInteger**
- **Numeric**
- **Comparable**
- **Equatable**
- **CustomStringConvertible**
- **Hashable**
## Requirements
- iOS 8.0+ / macOS 10.10+
- Xcode 8.0+
- Swift 4
## Communication
If you need any help or have a feature request, please open an issue here on GitHub;
if you found a bug or want to help with the development, please submit a pull request.
All contributions are welcome! :smiley:
## Installation
### Carthage
First, make sure have Carthage installed:
```
brew update
brew install carthage
```
To integrate this library into your Xcode project, simply put the following line into
your `carfile`:
```
github "hyugit/UInt256"
```
Finally, run `carthage update` to build the framework, and drag the built framework
(either `UInt256_iOS.framework` or `UInt256_macOS.framework`) into your Xcode project
### Swift Package Manager
This library supports **Swift Package Manager** as well. If you have your swift package
config set up already, please add the following line to your **Package.swift**:
```
dependencies: [
.package(url: "https://github.com/hyugit/UInt256.git", from: "4.0.0")
]
```
### CocoaPods
Install CocoaPods following its [official guide](http://guides.cocoapods.org/using/getting-started.html#installation)
To integrate UInt256 into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
target '' do
pod 'UInt256', :git => 'https://github.com/hyugit/UInt256.git'
end
```
And run `pod install` afterwards.
### Manual installation
You can also add this library manually to your project.
In the terminal, under your top level project directory, add this library as a
`git submodule` by running the following command:
```
git submodule add https://github.com/hyugit/UInt256.git
```
Have Xcode open, go to your new `UInt256` subdirectory in Finder, drag
`UInt256.xcodeproj` into the project navigator of your project. _Remember to embed
the framework to your build target._
## Next steps...
- [ ] add documentation
- [ ] look into leveraging GPU/Metal
- [x] benchmark
- [x] make UInt256 conform to FixedWidthInteger
- [x] add an example, preferably through a playground
- [x] add CocoaPods support
- [x] more tests, test coverage, corner cases, lint, code review
- [x] automate build and test runs
- [x] karatsuba multiplication
- [x] fast modulo, division, and other algos
## License
This library is released under the MIT license. Please see [LICENSE](https://github.com/hyugit/UInt256/blob/master/LICENSE)