diff --git a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts index 3df16df9b0a..d283b75afac 100644 --- a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts @@ -21,6 +21,7 @@ /* eslint-disable max-lines */ import add = require( '@stdlib/math/base/ops/add' ); +import add3 = require( '@stdlib/math/base/ops/add3' ); import addf = require( '@stdlib/math/base/ops/addf' ); import cadd = require( '@stdlib/math/base/ops/cadd' ); import caddf = require( '@stdlib/math/base/ops/caddf' ); @@ -28,8 +29,11 @@ import cdiv = require( '@stdlib/math/base/ops/cdiv' ); import cmul = require( '@stdlib/math/base/ops/cmul' ); import cmulf = require( '@stdlib/math/base/ops/cmulf' ); import cneg = require( '@stdlib/math/base/ops/cneg' ); +import cnegf = require( '@stdlib/math/base/ops/cnegf' ); import csub = require( '@stdlib/math/base/ops/csub' ); import csubf = require( '@stdlib/math/base/ops/csubf' ); +import div = require( '@stdlib/math/base/ops/div' ); +import divf = require( '@stdlib/math/base/ops/divf' ); import imul = require( '@stdlib/math/base/ops/imul' ); import imuldw = require( '@stdlib/math/base/ops/imuldw' ); import mul = require( '@stdlib/math/base/ops/mul' ); @@ -72,6 +76,36 @@ interface Namespace { */ add: typeof add; + /** + * Computes the sum of three double-precision floating-point numbers. + * + * @param x - first input value + * @param y - second input value + * @param z - third input value + * @returns sum + * + * @example + * var v = ns.add3( -1.0, 5.0, 2.0 ); + * // returns 6.0 + * + * @example + * var v = ns.add3( 2.0, 5.0, 2.0 ); + * // returns 9.0 + * + * @example + * var v = ns.add3( 0.0, 5.0, 2.0 ); + * // returns 7.0 + * + * @example + * var v = ns.add3( -0.0, 0.0, -0.0 ); + * // returns 0.0 + * + * @example + * var v = ns.add3( NaN, NaN, NaN ); + * // returns NaN + */ + add3: typeof add3; + /** * Computes the sum of two single-precision floating-point numbers `x` and `y`. * @@ -299,6 +333,65 @@ interface Namespace { */ cneg: typeof cneg; + /** + * Negates a single-precision complex floating-point number. + * + * @param z - complex number + * @returns result + * + * @example + * var Complex64 = require( `@stdlib/complex/float32` ); + * var realf = require( `@stdlib/complex/realf` ); + * var imagf = require( `@stdlib/complex/imagf` ); + * + * var z = new Complex64( -4.2, 5.5 ); + * // returns + * + * var out = ns.cnegf( z ); + * // returns + * + * var re = realf( out ); + * // returns 4.2 + * + * var im = imagf( out ); + * // returns -5.5 + * + * @example + * var Complex64 = require( `@stdlib/complex/float32` ); + * var realf = require( `@stdlib/complex/realf` ); + * var imagf = require( `@stdlib/complex/imagf` ); + * + * var z = new Complex64( 0.0, 0.0 ); + * // returns + * + * var out = ns.cnegf( z ); + * // returns + * + * var re = realf( out ); + * // returns -0.0 + * + * var im = imagf( out ); + * // returns -0.0 + * + * @example + * var Complex64 = require( `@stdlib/complex/float32` ); + * var realf = require( `@stdlib/complex/realf` ); + * var imagf = require( `@stdlib/complex/imagf` ); + * + * var z = new Complex64( NaN, NaN ); + * // returns + * + * var out = ns.cnegf( z ); + * // returns + * + * var re = realf( out ); + * // returns NaN + * + * var im = imagf( out ); + * // returns NaN + */ + cnegf: typeof cnegf; + /** * Subtracts two double-precision complex floating-point numbers. * @@ -357,6 +450,64 @@ interface Namespace { */ csubf: typeof csubf; + /** + * Divides two double-precision floating-point numbers `x` and `y`. + * + * @param x - first input value (divided) + * @param y - second input value (divisor) + * @returns result + * + * @example + * var v = ns.div( -1.0, 5.0 ); + * // returns -0.2 + * + * @example + * var v = ns.div( 2.0, 5.0 ); + * // returns 0.4 + * + * @example + * var v = ns.div( 0.0, 5.0 ); + * // returns 0.0 + * + * @example + * var v = ns.div( -0.0, 5.0 ); + * // returns -0.0 + * + * @example + * var v = ns.div( NaN, NaN ); + * // returns NaN + */ + div: typeof div; + + /** + * Divides two single-precision floating-point numbers `x` and `y`. + * + * @param x - first input value (divided) + * @param y - second input value (divisor) + * @returns result + * + * @example + * var v = ns.divf( -1.0, 5.0 ); + * // returns ~-0.2 + * + * @example + * var v = ns.divf( 2.0, 5.0 ); + * // returns ~0.4 + * + * @example + * var v = ns.divf( 0.0, 5.0 ); + * // returns 0.0 + * + * @example + * var v = ns.divf( -0.0, 5.0 ); + * // returns -0.0 + * + * @example + * var v = ns.divf( NaN, NaN ); + * // returns NaN + */ + divf: typeof divf; + /** * Performs C-like multiplication of two signed 32-bit integers. * diff --git a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts index 43e642c7ddd..f607c0d0349 100644 --- a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts @@ -122,6 +122,7 @@ import expit = require( '@stdlib/math/base/special/expit' ); import expm1 = require( '@stdlib/math/base/special/expm1' ); import expm1rel = require( '@stdlib/math/base/special/expm1rel' ); import factorial = require( '@stdlib/math/base/special/factorial' ); +import factorial2 = require( '@stdlib/math/base/special/factorial2' ); import factorialln = require( '@stdlib/math/base/special/factorialln' ); import fallingFactorial = require( '@stdlib/math/base/special/falling-factorial' ); import fast = require( '@stdlib/math/base/special/fast' ); @@ -3031,6 +3032,34 @@ interface Namespace { */ factorial: typeof factorial; + /** + * Evaluates the double factorial of `n`. + * + * @param n - input value + * @returns double factorial + * + * @example + * var v = ns.factorial2( 3 ); + * // returns 3 + * + * @example + * var v = ns.factorial2( 4 ); + * // returns 8 + * + * @example + * var v = ns.factorial2( -10 ); + * // returns NaN + * + * @example + * var v = ns.factorial2( 301 ); + * // returns Infinity + * + * @example + * var v = ns.factorial2( NaN ); + * // returns NaN + */ + factorial2: typeof factorial2; + /** * Evaluates the natural logarithm of the factorial of `x`. *