feat(sqrt): add directional sqrt support

Author: Rubilmax

src/index.ts

@@ -33,6 +33,8 @@ import {
   toPercentFloat,
   formatPercent,
   percentSqrt,
+  percentSqrtUp,
+  percentSqrtDown,
 } from "./percent";
 import {
   wadAdd,
@@ -54,6 +56,8 @@ import {
   toWadFloat,
   formatWad,
   wadSqrt,
+  wadSqrtUp,
+  wadSqrtDown,
 } from "./wad";
 import {
   rayAdd,
@@ -75,6 +79,8 @@ import {
   toRayFloat,
   formatRay,
   raySqrt,
+  raySqrtUp,
+  raySqrtDown,
 } from "./ray";
 
 declare global {
@@ -92,6 +98,8 @@ declare global {
     mulDivDown: (other: bigint, scale: bigint) => bigint;
 
     sqrt: () => bigint;
+    sqrtUp: () => bigint;
+    sqrtDown: () => bigint;
 
     compMul: (other: bigint) => bigint;
     compDiv: (other: bigint) => bigint;
@@ -110,6 +118,8 @@ declare global {
     percentPowDown: (exponent: bigint) => bigint;
     percentExpN: (exponent: bigint) => bigint;
     percentSqrt: () => bigint;
+    percentSqrtUp: () => bigint;
+    percentSqrtDown: () => bigint;
     percentToDecimals: (decimals: number) => bigint;
     percentToWad: () => bigint;
     percentToRay: () => bigint;
@@ -130,6 +140,8 @@ declare global {
     wadPowDown: (exponent: bigint) => bigint;
     wadExpN: (exponent: bigint) => bigint;
     wadSqrt: () => bigint;
+    wadSqrtUp: () => bigint;
+    wadSqrtDown: () => bigint;
     wadToDecimals: (decimals: number) => bigint;
     wadToPercent: () => bigint;
     wadToRay: () => bigint;
@@ -150,6 +162,8 @@ declare global {
     rayPowDown: (exponent: bigint) => bigint;
     rayExpN: (exponent: bigint) => bigint;
     raySqrt: () => bigint;
+    raySqrtUp: () => bigint;
+    raySqrtDown: () => bigint;
     rayToDecimals: (decimals: number) => bigint;
     rayToPercent: () => bigint;
     rayToWad: () => bigint;
@@ -205,8 +219,14 @@ BigInt.prototype.mulDivDown = function (other: bigint, scale: bigint) {
   return mulDivDown(this as bigint, other, scale);
 };
 
-BigInt.prototype.sqrt = function () {
-  return sqrt(this as bigint);
+BigInt.prototype.sqrt = function (scale = 1n) {
+  return sqrt(this as bigint, scale, mulDivHalfUp);
+};
+BigInt.prototype.sqrtUp = function (scale = 1n) {
+  return sqrt(this as bigint, scale, mulDivUp);
+};
+BigInt.prototype.sqrtDown = function (scale = 1n) {
+  return sqrt(this as bigint, scale, mulDivDown);
 };
 
 BigInt.prototype.compMul = function (other: bigint) {
@@ -258,6 +278,12 @@ BigInt.prototype.percentExpN = function (N: bigint) {
 BigInt.prototype.percentSqrt = function () {
   return percentSqrt(this as bigint);
 };
+BigInt.prototype.percentSqrtUp = function () {
+  return percentSqrtUp(this as bigint);
+};
+BigInt.prototype.percentSqrtDown = function () {
+  return percentSqrtDown(this as bigint);
+};
 BigInt.prototype.percentToDecimals = function (decimals: number) {
   return percentToDecimals(this as bigint, decimals);
 };
@@ -316,6 +342,12 @@ BigInt.prototype.wadExpN = function (N: bigint) {
 BigInt.prototype.wadSqrt = function () {
   return wadSqrt(this as bigint);
 };
+BigInt.prototype.wadSqrtUp = function () {
+  return wadSqrtUp(this as bigint);
+};
+BigInt.prototype.wadSqrtDown = function () {
+  return wadSqrtDown(this as bigint);
+};
 BigInt.prototype.wadToDecimals = function (decimals: number) {
   return wadToDecimals(this as bigint, decimals);
 };
@@ -374,6 +406,12 @@ BigInt.prototype.rayExpN = function (N: bigint) {
 BigInt.prototype.raySqrt = function () {
   return raySqrt(this as bigint);
 };
+BigInt.prototype.raySqrtUp = function () {
+  return raySqrtUp(this as bigint);
+};
+BigInt.prototype.raySqrtDown = function () {
+  return raySqrtDown(this as bigint);
+};
 BigInt.prototype.rayToDecimals = function (decimals: number) {
   return rayToDecimals(this as bigint, decimals);
 };

src/percent.ts

@@ -55,7 +55,15 @@ export const percentExpN = (x: bigint, N: bigint) => {
 };
 
 export const percentSqrt = (x: bigint) => {
-  return sqrt(x, PERCENT);
+  return sqrt(x, PERCENT, mulDivHalfUp);
+};
+
+export const percentSqrtUp = (x: bigint) => {
+  return sqrt(x, PERCENT, mulDivUp);
+};
+
+export const percentSqrtDown = (x: bigint) => {
+  return sqrt(x, PERCENT, mulDivDown);
 };
 
 export const percentToDecimals = (x: bigint, decimals: number) => {

src/ray.ts

@@ -55,7 +55,15 @@ export const rayExpN = (x: bigint, N: bigint) => {
 };
 
 export const raySqrt = (x: bigint) => {
-  return sqrt(x, RAY);
+  return sqrt(x, RAY, mulDivHalfUp);
+};
+
+export const raySqrtUp = (x: bigint) => {
+  return sqrt(x, RAY, mulDivUp);
+};
+
+export const raySqrtDown = (x: bigint) => {
+  return sqrt(x, RAY, mulDivDown);
 };
 
 export const rayToDecimals = (x: bigint, decimals: number) => {

src/utils.ts

@@ -53,12 +53,7 @@ export const mulDivUp: MulDiv = (x, y, scale) => {
 export const avgHalfUp = (x: bigint, y: bigint, pct: bigint, scale: bigint) =>
   (max(0n, scale - pct) * x + min(scale, pct) * y + scale / 2n) / scale;
 
-export const pow = (
-  x: bigint,
-  exponent: bigint,
-  scale: bigint,
-  mulDiv: MulDiv = mulDivHalfUp,
-): bigint => {
+export const pow = (x: bigint, exponent: bigint, scale: bigint, mulDiv: MulDiv): bigint => {
   if (exponent === 0n) return scale;
   if (exponent === 1n) return x;
 
@@ -68,7 +63,7 @@ export const pow = (
   return mulDiv(x, pow(xSquared, (exponent - 1n) / 2n, scale, mulDiv), scale);
 };
 
-export const sqrt = (x: bigint, scale = 1n, mulDiv: MulDiv = mulDivHalfUp) => {
+export const sqrt = (x: bigint, scale: bigint, mulDiv: MulDiv) => {
   if (x === 0n) return 0n;
 
   const scale2 = 2n * scale;
@@ -84,7 +79,7 @@ export const sqrt = (x: bigint, scale = 1n, mulDiv: MulDiv = mulDivHalfUp) => {
   return x0;
 };
 
-export const expN = (x: bigint, N: bigint, scale: bigint, mulDiv: MulDiv = mulDivDown) => {
+export const expN = (x: bigint, N: bigint, scale: bigint, mulDiv = mulDivDown) => {
   let res = scale;
   let monomial = scale;
   for (let k = 1n; k <= N; k++) {

src/wad.ts

@@ -55,7 +55,15 @@ export const wadExpN = (x: bigint, N: bigint) => {
 };
 
 export const wadSqrt = (x: bigint) => {
-  return sqrt(x, WAD);
+  return sqrt(x, WAD, mulDivHalfUp);
+};
+
+export const wadSqrtUp = (x: bigint) => {
+  return sqrt(x, WAD, mulDivUp);
+};
+
+export const wadSqrtDown = (x: bigint) => {
+  return sqrt(x, WAD, mulDivDown);
 };
 
 export const wadToDecimals = (x: bigint, decimals: number) => {