Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
Starfunk authored Jun 26, 2018
1 parent 563ba36 commit aa2268e
Show file tree
Hide file tree
Showing 4 changed files with 412 additions and 190 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[package]
name = "largeint"
version = "0.1.0"
version = "0.2.0"
authors = ["Maximilian Kahn <[email protected]>"]
license = "MIT"
description = "A library that supports large integer arithmetic using LargeInt."
description = "A library that supports large integer arithmetic."
readme = "README.md"
documentation = "https://docs.rs/largeint"
repository = "https://github.com/Starfunk/largeint"
keywords = ["largeint", "large", "int","bigint","num"]
categories = ["no-std"]
keywords = ["largeint", "int", "large","integer"]
categories = ["no-std", "data-structures"]

[dependencies]
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ let largeint3 = new(String::from("0"), Sign::Unsigned);
```
An instance of `LargeInt` contains two fields, the scalar value of the integer stored as a `String` and the sign of the integer stored as the enum, `Sign`, which can be `Positive`, `Negative`, or `Unsigned` (note that `0` is the only integer that should be assigned `Unsigned`).

Using `new` to create an instance of `LargeInt` is highly recommended as there are checks in place to ensure that the the instance of `LargeInt` will be created properly. For example, creating an instance of a `LargeInt` with a scalar value of `0` using `new` will automatically assign `Sign::Unsigned` to the sign of the LargeInt even if you enter another `Sign` variant.
Using `new` to create an instance of `LargeInt` is highly recommended as there are checks in place to ensure that the the instance of `LargeInt` will be created properly. For example, creating an instance of a `LargeInt` with a scalar value of `0` using `new` will automatically assign `Sign::Unsigned` to the sign of the LargeInt even if you enter another `Sign` variant.

The purpose of this library is to provide an easy-to-use large integer implementation in Rust.
The ideal user is one that is looking to write small scale projects for personal use and does
Expand Down Expand Up @@ -87,4 +87,3 @@ Multiplication, floor division - and remainder - have been added.

## License
This project is licensed under the MIT License - see [LICENSE.md](https://github.com/Starfunk/largeint/blob/master/LICENSE) for more details.

Loading

0 comments on commit aa2268e

Please sign in to comment.