Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(stdlib): Add examples to BigInt module #1944

Merged
merged 1 commit into from
Jan 25, 2024
Merged

chore(stdlib): Add examples to BigInt module #1944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions stdlib/bigint.gr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
*
* @example include "bigint"
*
* @example 9223372036854775809t
* @example 0t
* @example -9223372036854775809t
*
* @since v0.5.0
*/

Expand All @@ -27,6 +31,9 @@ provide { fromNumber, toNumber }
* @param num: The value to increment
* @returns The incremented value
*
* @example BigInt.incr(1t) == 2t
* @example BigInt.incr(-2t) == -1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -40,6 +47,9 @@ provide let incr = (num: BigInt) => {
* @param num: The value to decrement
* @returns The decremented value
*
* @example BigInt.decr(2t) == 1t
* @example BigInt.decr(-2t) == -3t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -53,6 +63,9 @@ provide let decr = (num: BigInt) => {
* @param num: The operand
* @returns The negated operand
*
* @example BigInt.neg(1t) == -1t
* @example BigInt.neg(-1t) == 1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -66,6 +79,9 @@ provide let neg = (num: BigInt) => {
* @param num: The operand
* @returns The operand's absolute value
*
* @example BigInt.abs(1t) == 1t
* @example BigInt.abs(-1t) == 1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -80,6 +96,10 @@ provide let abs = (num: BigInt) => {
* @param num2: The second operand
* @returns The sum of the two operands
*
* @example
* from BigInt use { (+) }
* assert 1t + 1t == 2t
*
* @since v0.6.0
* @history v0.5.0: Originally named `add`
*/
Expand All @@ -97,6 +117,10 @@ provide let (+) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The difference of the two operands
*
* @example
* from BigInt use { (-) }
* assert 3t - 1t == 2t
*
* @since v0.6.0
* @history v0.5.0: Originally named `sub`
*/
Expand All @@ -114,6 +138,10 @@ provide let (-) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The product of the two operands
*
* @example
* from BigInt use { (*) }
* assert 3t * 3t == 9t
*
* @since v0.6.0
* @history v0.5.0: Originally named `mul`
*/
Expand All @@ -134,6 +162,10 @@ provide let (*) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The quotient of its operands
*
* @example
* from BigInt use { (/) }
* assert 9t / 3t == 3t
*
* @since v0.6.0
* @history v0.5.0: Originally named `div`
*/
Expand All @@ -152,6 +184,8 @@ provide let (/) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The remainder of its operands
*
* @example BigInt.rem(3t, 2t) == 1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -168,6 +202,8 @@ provide let rem = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The quotient and remainder of its operands
*
* @example BigInt.quotRem(7t, 2t) == (3t, 1t))
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -187,6 +223,8 @@ provide let quotRem = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns The greatest common divisor of its operands
*
* @example BigInt.gcd(36t, 24t) == 12t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -203,6 +241,10 @@ provide let gcd = (num1: BigInt, num2: BigInt) => {
* @param places: The number of bits to shift by
* @returns The shifted value
*
* @example
* from BigInt use { (<<) }
* assert (10t << 2l) == 40t
*
* @since v0.6.0
* @history v0.5.0: Originally named `shl`
*/
Expand All @@ -220,6 +262,10 @@ provide let (<<) = (num: BigInt, places: Int32) => {
* @param places: The amount to shift by
* @returns The shifted value
*
* @example
* from BigInt use { (>>) }
* assert (9999t >> 2l) == 2499t
*
* @since v0.6.0
* @history v0.5.0: Originally named `shr`
*/
Expand All @@ -236,6 +282,9 @@ provide let (>>) = (num: BigInt, places: Int32) => {
* @param num: The value to inspect
* @returns `true` if the first value is equal to zero or `false` otherwise
*
* @example assert BigInt.eqz(0t) == true
* @example assert BigInt.eqz(1t) == false
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -252,6 +301,13 @@ provide let eqz = (num: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is equal to the second value or `false` otherwise
*
* @example
* from BigInt use { (==) }
* assert 1t == 1t
* @example
* from BigInt use { (==) }
* assert -10t == -10t
*
* @since v0.6.0
* @history v0.5.0: Originally named `eq`
*/
Expand All @@ -270,6 +326,13 @@ provide let (==) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is not equal to the second value or `false` otherwise
*
* @example
* from BigInt use { (!=) }
* assert 1t != 2t
* @example
* from BigInt use { (!=) }
* assert -10t != -20t
*
* @since v0.6.0
* @history v0.5.0: Originally named `ne`
*/
Expand All @@ -288,6 +351,13 @@ provide let (!=) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is less than the second value or `false` otherwise
*
* @example
* from BigInt use { (<) }
* assert 1t < 2t
* @example
* from BigInt use { (<) }
* assert -10t < 0t
*
* @since v0.6.0
* @history v0.5.0: Originally named `lt`
*/
Expand All @@ -306,6 +376,16 @@ provide let (<) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is less than or equal to the second value or `false` otherwise
*
* @example
* from BigInt use { (<=) }
* assert 1t <= 1t
* @example
* from BigInt use { (<=) }
* assert -10t <= 0t
* @example
* from BigInt use { (<=) }
* assert 2t <= 3t
*
* @since v0.6.0
* @history v0.5.0: Originally named `lte`
*/
Expand All @@ -324,6 +404,13 @@ provide let (<=) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is greater than the second value or `false` otherwise
*
* @example
* from BigInt use { (>) }
* assert 2t > 1t
* @example
* from BigInt use { (>) }
* assert 0t > -10t
*
* @since v0.6.0
* @history v0.5.0: Originally named `gt`
*/
Expand All @@ -342,6 +429,16 @@ provide let (>) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second value
* @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
*
* @example
* from BigInt use { (>=) }
* assert 1t >= 1t
* @example
* from BigInt use { (>=) }
* assert 0t >= -10t
* @example
* from BigInt use { (>=) }
* assert 3t >= 2t
*
* @since v0.6.0
* @history v0.5.0: Originally named `gte`
*/
Expand All @@ -359,6 +456,8 @@ provide let (>=) = (num1: BigInt, num2: BigInt) => {
* @param num: The given value
* @returns Containing the inverted bits of the given value
*
* @example BigInt.lnot(91234t) == -91235t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -373,6 +472,10 @@ provide let lnot = (num: BigInt) => {
* @param num2: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of both operands are `1`
*
* @example
* from BigInt use { (&) }
* assert (4t & 3t) == 0t
*
* @since v0.6.0
* @history v0.5.0: Originally named `land`
*/
Expand All @@ -390,6 +493,10 @@ provide let (&) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`
*
* @example
* from BigInt use { (|) }
* assert (5t | 3t) == 7t
*
* @since v0.6.0
* @history v0.5.0: Originally named `lor`
*/
Expand All @@ -407,6 +514,10 @@ provide let (|) = (num1: BigInt, num2: BigInt) => {
* @param num2: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`
*
* @example
* from BigInt use { (^) }
* assert (5t ^ 3t) == 6t
*
* @since v0.6.0
* @history v0.5.0: Originally named `lxor`
*/
Expand All @@ -424,6 +535,8 @@ provide let (^) = (num1: BigInt, num2: BigInt) => {
* @param num: The value to inspect
* @returns The amount of leading zeros
*
* @example BigInt.clz(5t) == 2147483647t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -439,6 +552,8 @@ provide let clz = (num: BigInt) => {
* @param num: The value to inspect
* @returns The amount of trailing zeros
*
* @example BigInt.ctz(14t) == 1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -455,6 +570,8 @@ provide let ctz = (num: BigInt) => {
* @param num: The value to inspect
* @returns The amount of 1-bits in its operand
*
* @example BigInt.popcnt(14t) == 1t
*
* @since v0.5.0
*/
@unsafe
Expand All @@ -475,6 +592,9 @@ provide let popcnt = (num: BigInt) => {
* @param num: The operand
* @returns The operand, as a string
*
* @example BigInt.toString(1t) == "1"
* @example BigInt.toString(-1t) == "-1"
*
* @since v0.5.0
*/
@unsafe
Expand Down
Loading
Loading