@cortex-js/compute-engine 0.24.0 → 0.25.0

package/dist/types/compute-engine/boxed-expression/numerics.d.ts

@@ -0,0 +1,41 @@
+/* 0.25.0 */
+import { Rational } from '../numerics/rationals';
+import { BoxedExpression } from './public';
+/**
+ * Attempt to factor a numeric coefficient `c` and a `rest` out of a
+ * canonical expression `expr` such that `ce.mul(c, rest)` is equal to `expr`.
+ *
+ * Attempts to make `rest` a positive value (i.e. pulls out negative sign).
+ *
+ * For example:
+ *
+ * ['Multiply', 2, 'x', 3, 'a']
+ *    -> [6, ['Multiply', 'x', 'a']]
+ *
+ * ['Divide', ['Multiply', 2, 'x'], ['Multiply', 3, 'y', 'a']]
+ *    -> [['Rational', 2, 3], ['Divide', 'x', ['Multiply, 'y', 'a']]]
+ */
+export declare function asCoefficient(expr: BoxedExpression): [coef: Rational, rest: BoxedExpression];
+export declare function asRational(expr: BoxedExpression): Rational | undefined;
+export declare function asApproximateRational(expr: BoxedExpression): Rational | undefined;
+export declare function div(lhs: Rational, rhs: Rational): Rational;
+/**
+ * Add a literal numeric value to a rational.
+ * If the rational is a bigint, this is a hint to do the calculation in bigint
+ * (no need to check `bignumPreferred()`).
+ * @param lhs
+ * @param rhs
+ * @returns
+ */
+export declare function add(lhs: Rational, rhs: BoxedExpression | Rational): Rational;
+export declare function mul(lhs: Rational, rhs: BoxedExpression | Rational): Rational;
+export declare function asFloat(expr: BoxedExpression | undefined): number | null;
+export declare function asBignum(expr: BoxedExpression | undefined): Decimal | null;
+export declare function asMachineInteger(expr: BoxedExpression | undefined): number | null;
+/**
+ *
+ * @param lhs
+ * @param rhs
+ * @returns the sign (-1, 0, 1) of the difference between `lhs` and `rhs`
+ */
+export declare function signDiff(lhs: BoxedExpression, rhs: BoxedExpression, tolerance?: number): -1 | 0 | 1 | undefined;

package/dist/types/compute-engine/boxed-expression/order.d.ts

@@ -1,11 +1,11 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export type Order = 'lex' | 'dexlex' | 'grevlex' | 'elim';
 export declare const DEFAULT_COMPLEXITY = 100000;
 /**
  * Sort by higher total degree (sum of degree), if tied, sort by max degree,
  * if tied,
  */
-export declare function sortAdd(ops: BoxedExpression[]): BoxedExpression[];
+export declare function sortAdd(ops: ReadonlyArray<BoxedExpression>): ReadonlyArray<BoxedExpression>;
 /**
  * Given two expressions `a` and `b`, return:
  * - `-1` if `a` should be ordered before `b`
@@ -53,7 +53,7 @@ export declare function canonicalOrder(expr: BoxedExpression, { recursive }: {
  *
  */
 export declare function polynomialOrder(expr: BoxedExpression): SemiBoxedExpression;
-export declare function lexicographicOrder(expr: BoxedExpression, vars?: string[]): SemiBoxedExpression;
-export declare function degreeLexicographicOrder(expr: BoxedExpression, vars?: string[]): SemiBoxedExpression;
-export declare function degreeReverseLexicographicOrder(expr: BoxedExpression, vars?: string[]): SemiBoxedExpression;
-export declare function eliminationOrder(expr: BoxedExpression, vars?: string[]): SemiBoxedExpression;
+export declare function lexicographicOrder(expr: BoxedExpression, vars?: ReadonlyArray<string>): SemiBoxedExpression;
+export declare function degreeLexicographicOrder(expr: BoxedExpression, vars?: ReadonlyArray<string>): SemiBoxedExpression;
+export declare function degreeReverseLexicographicOrder(expr: BoxedExpression, vars?: ReadonlyArray<string>): SemiBoxedExpression;
+export declare function eliminationOrder(expr: BoxedExpression, vars?: ReadonlyArray<string>): SemiBoxedExpression;