From 49ea69a6156308139c129b258fcaa3eb1c62cad8 Mon Sep 17 00:00:00 2001 From: Juanra Dikal Date: Wed, 24 Mar 2021 15:14:03 +0100 Subject: [PATCH] updated docs --- docs/API.md | 24 ++++++++++++------------ docs/interfaces/egcd.md | 8 ++++---- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/API.md b/docs/API.md index a3a7251..e1f2895 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,6 +1,6 @@ -bigint-mod-arith - v2.0.8 +bigint-mod-arith - v2.1.0 -# bigint-mod-arith - v2.0.8 +# bigint-mod-arith - v2.1.0 Some common functions for modular arithmetic using native JS implementation of BigInt @@ -41,7 +41,7 @@ Name | Type | The absolute value of a -Defined in: [ts/abs.ts:8](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/abs.ts#L8) +Defined in: [ts/abs.ts:8](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/abs.ts#L8) ___ @@ -61,7 +61,7 @@ Name | Type | The bit length -Defined in: [ts/bitLength.ts:7](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/bitLength.ts#L7) +Defined in: [ts/bitLength.ts:7](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/bitLength.ts#L7) ___ @@ -83,7 +83,7 @@ Name | Type | A triple (g, x, y), such that ax + by = g = gcd(a, b). -Defined in: [ts/egcd.ts:15](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/egcd.ts#L15) +Defined in: [ts/egcd.ts:15](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/egcd.ts#L15) ___ @@ -104,7 +104,7 @@ Name | Type | The greatest common divisor of a and b -Defined in: [ts/gcd.ts:10](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/gcd.ts#L10) +Defined in: [ts/gcd.ts:10](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/gcd.ts#L10) ___ @@ -125,7 +125,7 @@ Name | Type | The least common multiple of a and b -Defined in: [ts/lcm.ts:10](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/lcm.ts#L10) +Defined in: [ts/lcm.ts:10](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/lcm.ts#L10) ___ @@ -146,7 +146,7 @@ Name | Type | Maximum of numbers a and b -Defined in: [ts/max.ts:9](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/max.ts#L9) +Defined in: [ts/max.ts:9](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/max.ts#L9) ___ @@ -167,7 +167,7 @@ Name | Type | Minimum of numbers a and b -Defined in: [ts/min.ts:9](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/min.ts#L9) +Defined in: [ts/min.ts:9](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/min.ts#L9) ___ @@ -188,7 +188,7 @@ Name | Type | Description | The inverse modulo n or number NaN if it does not exist -Defined in: [ts/modInv.ts:11](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/modInv.ts#L11) +Defined in: [ts/modInv.ts:11](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/modInv.ts#L11) ___ @@ -210,7 +210,7 @@ Name | Type | Description | b**e mod n or number NaN if n <= 0 -Defined in: [ts/modPow.ts:13](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/modPow.ts#L13) +Defined in: [ts/modPow.ts:13](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/modPow.ts#L13) ___ @@ -234,4 +234,4 @@ Name | Type | Description | A bigint with the smallest positive representation of a modulo n or number NaN if n < 0 -Defined in: [ts/toZn.ts:12](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/toZn.ts#L12) +Defined in: [ts/toZn.ts:12](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/toZn.ts#L12) diff --git a/docs/interfaces/egcd.md b/docs/interfaces/egcd.md index 3dfb6ee..c86f165 100644 --- a/docs/interfaces/egcd.md +++ b/docs/interfaces/egcd.md @@ -1,4 +1,4 @@ -[bigint-mod-arith - v2.0.8](../API.md) / Egcd +[bigint-mod-arith - v2.1.0](../API.md) / Egcd # Interface: Egcd @@ -16,7 +16,7 @@ • **g**: *bigint* -Defined in: [ts/egcd.ts:2](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/egcd.ts#L2) +Defined in: [ts/egcd.ts:2](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/egcd.ts#L2) ___ @@ -24,7 +24,7 @@ ___ • **x**: *bigint* -Defined in: [ts/egcd.ts:3](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/egcd.ts#L3) +Defined in: [ts/egcd.ts:3](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/egcd.ts#L3) ___ @@ -32,4 +32,4 @@ ___ • **y**: *bigint* -Defined in: [ts/egcd.ts:4](https://github.com/juanelas/bigint-mod-arith/blob/49158bd/src/ts/egcd.ts#L4) +Defined in: [ts/egcd.ts:4](https://github.com/juanelas/bigint-mod-arith/blob/6131edd/src/ts/egcd.ts#L4)