@sheetxl/formulas 0.8.0-beta.1 → 0.8.0-beta.11

package/types/src/mathTrig/Trig.d.ts

@@ -1,106 +1,110 @@
 /**
- * @summary Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number.
+ * Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number.
  * @param number is the cosine of the angle you want and must be from -1 to 1.
  */
 export declare function ACOS(number: number): number;
 /**
- * @summary Returns the inverse hyperbolic cosine of a number.
+ * Returns the inverse hyperbolic cosine of a number.
  * @param number is any real number equal to or greater than 1.
  */
 export declare function ACOSH(number: number): number;
 /**
- * @summary Returns the arccotangent of a number, in radians in the range 0 to Pi.
+ * Returns the arccotangent of a number, in radians in the range 0 to Pi.
  * @param number is the cotangent of the angle you want.
  */
 export declare function ACOT(number: number): number;
 /**
- * @summary Returns the inverse hyperbolic cotangent of a number.
+ * Returns the inverse hyperbolic cotangent of a number.
  * @param number is the hyperbolic cotangent of the angle that you want.
  */
 export declare function ACOTH(number: number): number;
 /**
- * @summary Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.
+ * Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.
  * @param number is the sine of the angle you want and must be from -1 to 1.
  */
 export declare function ASIN(number: number): number;
 /**
- * @summary Returns the inverse hyperbolic sine of a number.
- * @param number is any real number equal to or greater than 1.
+ * Returns the inverse hyperbolic sine of a number.
+ * @param number is any real number.
  */
 export declare function ASINH(number: number): number;
 /**
- * @summary Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.
+ * Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.
  * @param number is the tangent of the angle you want.
  */
 export declare function ATAN(number: number): number;
 /**
- * @summary Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.
+ * Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.
  * @param x is the x-coordinate of the point.
  * @param y is the y-coordinate of the point.
+ *
+ * @remarks
+ * The angle is reached through the RATIO `y/x`, so a pair whose ratio overflows is `#NUM!` even
+ * where the angle itself is ordinary: `ATAN2(1E-300,1E307)` is `#NUM!` and not Pi/2.
  */
 export declare function ATAN2(x: number, y: number): number;
 /**
- * @summary Returns the inverse hyperbolic tangent of a number.
+ * Returns the inverse hyperbolic tangent of a number.
  * @param number is any real number between -1 and 1 excluding -1 and 1.
  */
 export declare function ATANH(number: number): number;
 /**
- * @summary Returns the cosine of an angle.
+ * Returns the cosine of an angle.
  * @param number is the angle in radians for which you want the cosine.
  */
 export declare function COS(number: number): number;
 /**
- * @summary Returns the hyperbolic cosine of a number.
+ * Returns the hyperbolic cosine of a number.
  * @param number is any real number.
  */
 export declare function COSH(number: number): number;
 /**
- * @summary Returns the cotangent of an angle.
+ * Returns the cotangent of an angle.
  * @param number is the angle in radians for which you want the cotangent.
  */
 export declare function COT(number: number): number;
 /**
- * @summary Returns the hyperbolic cotangent of a number.
+ * Returns the hyperbolic cotangent of a number.
  * @param number is the angle in radians for which you want the hyperbolic cotangent.
  */
 export declare function COTH(number: number): number;
 /**
- * @summary Returns the cosecant of an angle.
+ * Returns the cosecant of an angle.
  * @param number is the angle in radians for which you want the cosecant.
  */
 export declare function CSC(number: number): number;
 /**
- * @summary Returns the hyperbolic cosecant of an angle.
+ * Returns the hyperbolic cosecant of an angle.
  * @param number is the angle in radians for which you want the hyperbolic cosecant.
  */
 export declare function CSCH(number: number): number;
 /**
- * @summary Returns the secant of an angle.
+ * Returns the secant of an angle.
  * @param number is the angle in radians for which you want the secant.
  */
 export declare function SEC(number: number): number;
 /**
- * @summary Returns the hyperbolic secant of an angle.
+ * Returns the hyperbolic secant of an angle.
  * @param number is the angle in radians for which you want the hyperbolic secant.
  */
 export declare function SECH(number: number): number;
 /**
- * @summary Returns the sine of an angle.
+ * Returns the sine of an angle.
  * @param number is the angle in radians for which you want the sine. Degrees * PI()/180 = radians.
  */
 export declare function SIN(number: number): number;
 /**
- * @summary Returns the hyperbolic sine of a number.
+ * Returns the hyperbolic sine of a number.
  * @param number is any real number.
  */
 export declare function SINH(number: number): number;
 /**
- * @summary Returns the tangent of an angle.
+ * Returns the tangent of an angle.
  * @param number is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians.
  */
 export declare function TAN(number: number): number;
 /**
- * @summary Returns the hyperbolic tangent of a number.
+ * Returns the hyperbolic tangent of a number.
  * @param number is any real number.
  */
 export declare function TANH(number: number): number;

package/types/src/operators/Operators.d.ts

@@ -1,101 +1,101 @@
 import { Scalar } from '@sheetxl/primitives';
 /**
- * @summary Returns the sum of two numbers. Equal to the '+' operator.
+ * Returns the sum of two numbers. Equal to the '+' operator.
  * @param value1 The first number to add.
  * @param value2 The second number to add.
  * @category Sheets
  */
 export declare function ADD(value1: number, value2: number): number;
 /**
- * @summary Returns the result of dividing one number by another. Equal to the '/' operator.
+ * Returns the result of dividing one number by another. Equal to the '/' operator.
  * @param dividend The number to be divided.
  * @param divisor The number to divide by.
  * @category Sheets
  */
 export declare function DIVIDE(dividend: number, divisor: number): number;
 /**
- * @summary Returns TRUE if the two specified values are equal. Equal to the '=' operator.
+ * Returns TRUE if the two specified values are equal. Equal to the '=' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function EQ(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns TRUE if the first value is greater than the second. Equal to the '>' operator.
+ * Returns TRUE if the first value is greater than the second. Equal to the '>' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function GT(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns TRUE if the first value is greater than or equal to the second. Equal to the '>=' operator.
+ * Returns TRUE if the first value is greater than or equal to the second. Equal to the '>=' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function GTE(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns TRUE if the first value is less than the second. Equal to the '<' operator.
+ * Returns TRUE if the first value is less than the second. Equal to the '<' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function LT(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns TRUE if the first value is less than or equal to the second. Equal to the '<=' operator.
+ * Returns TRUE if the first value is less than or equal to the second. Equal to the '<=' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function LTE(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns the difference of two numbers. Equal to the '-' operator.
+ * Returns the difference of two numbers. Equal to the '-' operator.
  * @param value1 The number from which to subtract.
  * @param value2 The number to subtract.
  * @category Sheets
  */
 export declare function MINUS(value1: number, value2: number): number;
 /**
- * @summary Returns the product of two numbers. Equal to the '*' operator.
+ * Returns the product of two numbers. Equal to the '*' operator.
  * @param value1 The first number to multiply.
  * @param value2 The second number to multiply.
  * @category Sheets
  */
 export declare function MULTIPLY(value1: number, value2: number): number;
 /**
- * @summary Returns TRUE if the two specified values are not equal. Equal to the '<>' operator.
+ * Returns TRUE if the two specified values are not equal. Equal to the '<>' operator.
  * @param value1 The first value to compare.
  * @param value2 The second value to compare.
  * @category Sheets
  */
 export declare function NE(value1: Scalar, value2: Scalar): boolean;
 /**
- * @summary Returns a number raised to a power. Equal to the '^' operator.
+ * Returns a number raised to a power. Equal to the '^' operator.
  * @param base The number to raise to a power.
  * @param exponent The power to raise the base to.
  * @category Sheets
  */
 export declare function POW(base: number, exponent: number): number;
 /**
- * @summary Returns the negation of a number. Equal to the unary '-' operator.
+ * Returns the negation of a number. Equal to the unary '-' operator.
  * @param value The number to negate.
  * @category Sheets
  */
 export declare function UMINUS(value: number): number;
 /**
- * @summary Converts a number to a percentage. Equal to the '%' operator.
+ * Converts a number to a percentage. Equal to the '%' operator.
  * @param value The number to convert to a percentage.
  * @category Sheets
  */
 export declare function UNARY_PERCENT(value: number): number;
 /**
- * @summary Returns a number unchanged. Equal to the unary '+' operator.
+ * Returns a number unchanged. Equal to the unary '+' operator.
  * @param value The number to return.
  * @category Sheets
  */
 export declare function UPLUS(value: number): number;
 /**
- * @summary Checks whether a number is between two numbers, inclusive by default.
+ * Checks whether a number is between two numbers, inclusive by default.
  * @param value The value to test.
  * @param lower The lower bound.
  * @param upper The upper bound.