You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/help/lib/db.js
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1714,7 +1714,8 @@ var db = {
1714
1714
"whilst": "\nwhilst( predicate, fcn[, thisArg] )\n Invokes a function while a test condition is true.\n\n When invoked, both the predicate function and the function to invoke are\n provided a single argument:\n\n - `i`: iteration number (starting from zero)\n\n Parameters\n ----------\n predicate: Function\n The predicate function which indicates whether to continue invoking a\n function.\n\n fcn: Function\n The function to invoke.\n\n thisArg: any (optional)\n Execution context for the invoked function.\n\n Examples\n --------\n > function predicate( i ) { return ( i < 5 ); };\n > function beep( i ) { console.log( 'boop: %d', i ); };\n > whilst( predicate, beep )\n boop: 0\n boop: 1\n boop: 2\n boop: 3\n boop: 4\n\n See Also\n --------\n doUntil, doWhile, until, whileAsync, whileEach\n",
1715
1715
"writableProperties": "\nwritableProperties( value )\n Returns an array of an object's own writable property names and symbols.\n\n Property order is not guaranteed, as object property enumeration is not\n specified according to the ECMAScript specification. In practice, however,\n most engines use insertion order to sort an object's properties, thus\n allowing for deterministic extraction.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n props: Array\n List of an object's own writable properties.\n\n Examples\n --------\n > function Foo() { this.beep = 'boop'; return this; };\n > Foo.prototype.foo = 'bar';\n > var obj = new Foo();\n > var props = writableProperties( obj )\n [ 'beep' ]\n\n See Also\n --------\n writablePropertiesIn, properties\n",
1716
1716
"writablePropertiesIn": "\nwritablePropertiesIn( value )\n Returns an array of an object's own and inherited writable property names\n and symbols.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n props: Array\n List of an object's own and inherited writable property names and\n symbols.\n\n Examples\n --------\n > var props = writablePropertiesIn( [] )\n\n See Also\n --------\n writableProperties, propertiesIn\n",
1717
-
"writablePropertyNames": "\nwritablePropertyNames( value )\n Returns an array of an object's own writable property names.\n\n Name order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n keys: Array\n List of an object's own writable property names.\n\n Examples\n --------\n > var obj = { 'a': 'b' };\n > var desc = {};\n > desc.configurable = false;\n > desc.enumerable = true;\n > desc.writable = false;\n > desc.value = 'boop';\n > defineProperty( obj, 'beep', desc );\n > var keys = writablePropertyNames( obj )\n [ 'a' ]\n\n See Also\n --------\n writableProperties, propertyNames\n",
1717
+
"writablePropertyNames": "\nwritablePropertyNames( value )\n Returns an array of an object's own writable property names.\n\n Name order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n keys: Array\n List of an object's own writable property names.\n\n Examples\n --------\n > var obj = { 'a': 'b' };\n > var desc = {};\n > desc.configurable = false;\n > desc.enumerable = true;\n > desc.writable = false;\n > desc.value = 'boop';\n > defineProperty( obj, 'beep', desc );\n > var keys = writablePropertyNames( obj )\n [ 'a' ]\n\n See Also\n --------\n writableProperties, writablePropertyNamesIn, propertyNames\n",
1718
+
"writablePropertyNamesIn": "\nwritablePropertyNamesIn( value )\n Returns an array of an object's own and inherited writable property names.\n\n Name order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n keys: Array\n List of an object's own and inherited writable property names.\n\n Examples\n --------\n > var obj = { 'a': 'b' };\n > var desc = {};\n > desc.configurable = true;\n > desc.enumerable = true;\n > desc.writable = false;\n > desc.value = 'boop';\n > defineProperty( obj, 'beep', desc );\n > var keys = writablePropertyNamesIn( obj )\n e.g., [ 'a', ... ]\n\n See Also\n --------\n writablePropertiesIn, writablePropertyNames, propertyNamesIn\n",
1718
1719
"writeFile": "\nwriteFile( file, data[, options,] clbk )\n Asynchronously writes data to a file.\n\n Parameters\n ----------\n file: string|Buffer|integer\n Filename or file descriptor.\n\n data: string|Buffer\n Data to write.\n\n options: Object|string (optional)\n Options. If a string, the value is the encoding.\n\n options.encoding: string|null (optional)\n Encoding. The encoding option is ignored if the data argument is a\n buffer. Default: 'utf8'.\n\n options.flag: string (optional)\n Flag. Default: 'w'.\n\n options.mode: integer (optional)\n Mode. Default: 0o666.\n\n clbk: Function\n Callback to invoke upon writing data to a file.\n\n Examples\n --------\n > function onWrite( error ) {\n ... if ( error ) {\n ... console.error( error.message );\n ... }\n ... };\n > writeFile( './beep/boop.txt', 'beep boop', onWrite );\n\n\nwriteFile.sync( file, data[, options] )\n Synchronously writes data to a file.\n\n Parameters\n ----------\n file: string|Buffer|integer\n Filename or file descriptor.\n\n data: string|Buffer\n Data to write.\n\n options: Object|string (optional)\n Options. If a string, the value is the encoding.\n\n options.encoding: string|null (optional)\n Encoding. The encoding option is ignored if the data argument is a\n buffer. Default: 'utf8'.\n\n options.flag: string (optional)\n Flag. Default: 'w'.\n\n options.mode: integer (optional)\n Mode. Default: 0o666.\n\n Returns\n -------\n err: Error|null\n Error object or null.\n\n Examples\n --------\n > var err = writeFile.sync( './beep/boop.txt', 'beep boop' );\n\n See Also\n --------\n exists, readFile\n",
1719
1720
"zip": "\nzip( ...arr[, options] )\n Generates array tuples from input arrays.\n\n Parameters\n ----------\n arr: ...Array\n Input arrays to be zipped.\n\n options: Object (optional)\n Options.\n\n options.trunc: boolean (optional)\n Boolean indicating whether to truncate arrays longer than the shortest\n input array. Default: `true`.\n\n options.fill: any (optional)\n Fill value used for arrays of unequal length. Default: `null`.\n\n options.arrays: boolean (optional)\n Boolean indicating whether an input array should be interpreted as an\n array of arrays to be zipped. Default: `false`.\n\n Returns\n -------\n out: Array\n Array of arrays.\n\n Examples\n --------\n // Basic usage:\n > var out = zip( [ 1, 2 ], [ 'a', 'b' ] )\n [ [ 1, 'a' ], [ 2, 'b' ] ]\n\n // Turn off truncation:\n > var opts = { 'trunc': false };\n > out = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts )\n [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]\n\n See Also\n --------\n unzip\n",
1720
1721
"ztest": "\nztest( x, sigma[, options] )\n Computes a one-sample z-test.\n\n The function performs a one-sample z-test for the null hypothesis that the\n data in array or typed array `x` is drawn from a normal distribution with\n mean zero and standard deviation `sigma`.\n\n The returned object comes with a `.print()` method which when invoked will\n print a formatted output of the results of the hypothesis test.\n\n Parameters\n ----------\n x: Array<number>\n Data array.\n\n sigma: number\n Known standard deviation.\n\n options: Object (optional)\n Options.\n\n options.alpha: number (optional)\n Number in the interval `[0,1]` giving the significance level of the\n hypothesis test. Default: `0.05`.\n\n options.alternative: string (optional)\n Indicates whether the alternative hypothesis is that the mean of `x` is\n larger than `mu` (`greater`), smaller than `mu` (`less`) or equal to\n `mu` (`two-sided`). Default: `'two-sided'`.\n\n options.mu: number (optional)\n Hypothesized true mean under the null hypothesis. Set this option to\n test whether the data comes from a distribution with the specified `mu`.\n Default: `0`.\n\n Returns\n -------\n out: Object\n Test result object.\n\n out.alpha: number\n Used significance level.\n\n out.rejected: boolean\n Test decision.\n\n out.pValue: number\n p-value of the test.\n\n out.statistic: number\n Value of test statistic.\n\n out.ci: Array<number>\n 1-alpha confidence interval for mean.\n\n out.nullValue: number\n Assumed mean value under H0.\n\n out.sd: number\n Standard error.\n\n out.alternative: string\n Alternative hypothesis (`two-sided`, `less` or `greater`).\n\n out.method: string\n Name of test (`One-Sample z-test`).\n\n out.print: Function\n Function to print formatted output.\n\n Examples\n --------\n // One-sample z-test:\n > var rnorm = base.random.normal.factory( 0.0, 2.0, { 'seed': 212 });\n > var x = new Array( 100 );\n > for ( var i = 0; i < x.length; i++ ) {\n ... x[ i ] = rnorm();\n ... }\n > var out = ztest( x, 2.0 )\n {\n alpha: 0.05,\n rejected: false,\n pValue: ~0.180,\n statistic: ~-1.34,\n ci: [ ~-0.66, ~0.124 ],\n ...\n }\n\n // Choose custom significance level and print output:\n > arr = [ 2, 4, 3, 1, 0 ];\n > out = ztest( arr, 2.0, { 'alpha': 0.01 });\n > table = out.print()\n One-sample z-test\n\n Alternative hypothesis: True mean is not equal to 0\n\n pValue: 0.0253\n statistic: 2.2361\n 99% confidence interval: [-0.3039,4.3039]\n\n Test Decision: Fail to reject null in favor of alternative at 1%\n significance level\n\n\n // Test for a mean equal to five:\n > var arr = [ 4, 4, 6, 6, 5 ];\n > out = ztest( arr, 1.0, { 'mu': 5 })\n {\n rejected: false,\n pValue: 1,\n statistic: 0,\n ci: [ ~4.123, ~5.877 ],\n // ...\n }\n\n // Perform one-sided tests:\n > arr = [ 4, 4, 6, 6, 5 ];\n > out = ztest( arr, 1.0, { 'alternative': 'less' })\n {\n alpha: 0.05,\n rejected: false,\n pValue: 1,\n statistic: 11.180339887498949,\n ci: [ -Infinity, 5.735600904580115 ],\n // ...\n }\n > out = ztest( arr, 1.0, { 'alternative': 'greater' })\n {\n alpha: 0.05,\n rejected: true,\n pValue: 0,\n statistic: 11.180339887498949,\n ci: [ 4.264399095419885, Infinity ],\n //...\n }\n\n See Also\n --------\n ztest2\n",
0 commit comments