diff --git a/CONTRIBUTORS b/CONTRIBUTORS index fcfcfa23d..67abc19c0 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -73,6 +73,7 @@ Shivam <11shivam00@gmail.com> Shraddheya Shendre Shubh Mehta <93862397+Shubh942@users.noreply.github.com> Shubham Mishra +Sivam Das <100067002+Sivam2313@users.noreply.github.com> Snehil Shah <130062020+Snehil-Shah@users.noreply.github.com> Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com> Spandan Barve @@ -83,6 +84,7 @@ Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com> Utkarsh Utkarsh Raj Varad Gupta +Xiaochuan Ye Yernar Yergaziyev naveen nishant-s7 <97207366+nishant-s7@users.noreply.github.com> diff --git a/base/special/ellipj/lib/assign.js b/base/special/ellipj/lib/assign.js index 976d2150e..edfafbb54 100644 --- a/base/special/ellipj/lib/assign.js +++ b/base/special/ellipj/lib/assign.js @@ -59,23 +59,23 @@ var ca = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; * @returns {Collection} output array * * @example -* var v = ellipj( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); +* var v = assign( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); * // returns [ ~0.293, ~0.956, ~0.978, ~0.298 ] * * @example -* v = ellipj( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); +* v = assign( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); * // returns [ ~0.0, ~1.0, ~1.0, ~0.0 ] * * @example -* v = ellipj( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); +* v = assign( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); * // returns [ ~1.0, ~0.0, ~0.0, ~1.571 ] * * @example -* v = ellipj( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); +* v = assign( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); * // returns [ ~0.0, ~1.0, ~1.0, NaN ] * * @example -* v = ellipj( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); +* v = assign( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 ); * // returns [ NaN, NaN, NaN, NaN ] */ function assign(u, m, out, stride, offset) { diff --git a/base/special/falling-factorial/lib/main.js b/base/special/falling-factorial/lib/main.js index fefe88052..1fec82549 100644 --- a/base/special/falling-factorial/lib/main.js +++ b/base/special/falling-factorial/lib/main.js @@ -67,6 +67,7 @@ var MAX_FACTORIAL = 170; // TODO: consider packaging as constant * \operatorname{risingFactorial}(x, n) = \frac{ \Gamma(x + n) }{ \Gamma(x) }; * ``` * +* @private * @param {number} x - first function parameter * @param {integer} n - second function parameter * @returns {number} function value diff --git a/base/special/lib/index.js b/base/special/lib/index.js index edb881d6b..0e08148fc 100644 --- a/base/special/lib/index.js +++ b/base/special/lib/index.js @@ -81,6 +81,24 @@ setReadOnly( special, 'absf', require( './../../../base/special/absf' ) ); */ setReadOnly( special, 'acos', require( './../../../base/special/acos' ) ); +/** +* @name acosd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acosd} +*/ +setReadOnly( special, 'acosd', require( './../../../base/special/acosd' ) ); + +/** +* @name acosf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acosf} +*/ +setReadOnly( special, 'acosf', require( './../../../base/special/acosf' ) ); + /** * @name acosh * @memberof special @@ -99,6 +117,24 @@ setReadOnly( special, 'acosh', require( './../../../base/special/acosh' ) ); */ setReadOnly( special, 'acot', require( './../../../base/special/acot' ) ); +/** +* @name acotd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acotd} +*/ +setReadOnly( special, 'acotd', require( './../../../base/special/acotd' ) ); + +/** +* @name acotf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acotf} +*/ +setReadOnly( special, 'acotf', require( './../../../base/special/acotf' ) ); + /** * @name acoth * @memberof special @@ -135,6 +171,33 @@ setReadOnly( special, 'acoversin', require( './../../../base/special/acoversin' */ setReadOnly( special, 'acsc', require( './../../../base/special/acsc' ) ); +/** +* @name acscd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acscd} +*/ +setReadOnly( special, 'acscd', require( './../../../base/special/acscd' ) ); + +/** +* @name acscdf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acscdf} +*/ +setReadOnly( special, 'acscdf', require( './../../../base/special/acscdf' ) ); + +/** +* @name acscf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/acscf} +*/ +setReadOnly( special, 'acscf', require( './../../../base/special/acscf' ) ); + /** * @name acsch * @memberof special @@ -171,6 +234,33 @@ setReadOnly( special, 'ahaversin', require( './../../../base/special/ahaversin' */ setReadOnly( special, 'asec', require( './../../../base/special/asec' ) ); +/** +* @name asecd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asecd} +*/ +setReadOnly( special, 'asecd', require( './../../../base/special/asecd' ) ); + +/** +* @name asecdf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asecdf} +*/ +setReadOnly( special, 'asecdf', require( './../../../base/special/asecdf' ) ); + +/** +* @name asecf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asecf} +*/ +setReadOnly( special, 'asecf', require( './../../../base/special/asecf' ) ); + /** * @name asech * @memberof special @@ -189,6 +279,33 @@ setReadOnly( special, 'asech', require( './../../../base/special/asech' ) ); */ setReadOnly( special, 'asin', require( './../../../base/special/asin' ) ); +/** +* @name asind +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asind} +*/ +setReadOnly( special, 'asind', require( './../../../base/special/asind' ) ); + +/** +* @name asindf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asindf} +*/ +setReadOnly( special, 'asindf', require( './../../../base/special/asindf' ) ); + +/** +* @name asinf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/asinf} +*/ +setReadOnly( special, 'asinf', require( './../../../base/special/asinf' ) ); + /** * @name asinh * @memberof special @@ -216,6 +333,24 @@ setReadOnly( special, 'atan', require( './../../../base/special/atan' ) ); */ setReadOnly( special, 'atan2', require( './../../../base/special/atan2' ) ); +/** +* @name atand +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/atand} +*/ +setReadOnly( special, 'atand', require( './../../../base/special/atand' ) ); + +/** +* @name atanf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/atanf} +*/ +setReadOnly( special, 'atanf', require( './../../../base/special/atanf' ) ); + /** * @name atanh * @memberof special @@ -657,6 +792,15 @@ setReadOnly( special, 'copysignf', require( './../../../base/special/copysignf' */ setReadOnly( special, 'cos', require( './../../../base/special/cos' ) ); +/** +* @name cosd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/cosd} +*/ +setReadOnly( special, 'cosd', require( './../../../base/special/cosd' ) ); + /** * @name cosh * @memberof special @@ -693,6 +837,15 @@ setReadOnly( special, 'cospi', require( './../../../base/special/cospi' ) ); */ setReadOnly( special, 'cot', require( './../../../base/special/cot' ) ); +/** +* @name cotd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/cotd} +*/ +setReadOnly( special, 'cotd', require( './../../../base/special/cotd' ) ); + /** * @name coth * @memberof special @@ -756,6 +909,24 @@ setReadOnly( special, 'cround', require( './../../../base/special/cround' ) ); */ setReadOnly( special, 'croundn', require( './../../../base/special/croundn' ) ); +/** +* @name csc +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/csc} +*/ +setReadOnly( special, 'csc', require( './../../../base/special/csc' ) ); + +/** +* @name cscd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/cscd} +*/ +setReadOnly( special, 'cscd', require( './../../../base/special/cscd' ) ); + /** * @name csch * @memberof special @@ -1341,6 +1512,15 @@ setReadOnly( special, 'kernelBetaincinv', require( './../../../base/special/kern */ setReadOnly( special, 'kernelCos', require( './../../../base/special/kernel-cos' ) ); +/** +* @name kernelLog1p +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/kernel-log1p} +*/ +setReadOnly( special, 'kernelLog1p', require( './../../../base/special/kernel-log1p' ) ); + /** * @name kernelSin * @memberof special @@ -1701,6 +1881,15 @@ setReadOnly( special, 'powm1', require( './../../../base/special/powm1' ) ); */ setReadOnly( special, 'rad2deg', require( './../../../base/special/rad2deg' ) ); +/** +* @name rad2degf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/rad2degf} +*/ +setReadOnly( special, 'rad2degf', require( './../../../base/special/rad2degf' ) ); + /** * @name ramp * @memberof special @@ -1728,6 +1917,15 @@ setReadOnly( special, 'rampf', require( './../../../base/special/rampf' ) ); */ setReadOnly( special, 'rcbrt', require( './../../../base/special/rcbrt' ) ); +/** +* @name rcbrtf +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/rcbrtf} +*/ +setReadOnly( special, 'rcbrtf', require( './../../../base/special/rcbrtf' ) ); + /** * @name rempio2 * @memberof special @@ -1827,6 +2025,15 @@ setReadOnly( special, 'rsqrt', require( './../../../base/special/rsqrt' ) ); */ setReadOnly( special, 'rsqrtf', require( './../../../base/special/rsqrtf' ) ); +/** +* @name secd +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/secd} +*/ +setReadOnly( special, 'secd', require( './../../../base/special/secd' ) ); + /** * @name sici * @memberof special @@ -1962,6 +2169,15 @@ setReadOnly( special, 'sqrtpi', require( './../../../base/special/sqrtpi' ) ); */ setReadOnly( special, 'tan', require( './../../../base/special/tan' ) ); +/** +* @name tand +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/tand} +*/ +setReadOnly( special, 'tand', require( './../../../base/special/tand' ) ); + /** * @name tanh * @memberof special