Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jun 26, 2024
1 parent 1fa7f7c commit adf0392
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ A total of 9 people contributed to this release. Thank you to the following cont

<details>

- [`ebb5167`](https://github.com/stdlib-js/stdlib/commit/ebb5167498be78c43ce809bc13a750f1c0887c7b) - **docs:** update REPL namespace documentation [(#2467)](https://github.com/stdlib-js/stdlib/pull/2467) _(by stdlib-bot, Athan Reines)_
- [`882197a`](https://github.com/stdlib-js/stdlib/commit/882197a80d23b8488e3d1b169151e506477e5b9a) - **docs:** update REPL namespace documentation [(#2466)](https://github.com/stdlib-js/stdlib/pull/2466) _(by stdlib-bot, Athan Reines)_
- [`bfd5b70`](https://github.com/stdlib-js/stdlib/commit/bfd5b7069450a1469a68e52b334412596b8892ef) - **docs:** update REPL namespace documentation [(#2444)](https://github.com/stdlib-js/stdlib/pull/2444) _(by stdlib-bot, Athan Reines)_
- [`211c131`](https://github.com/stdlib-js/stdlib/commit/211c131b7d2761f3627a85ab47fdb07e242cc1c9) - **docs:** update REPL namespace documentation [(#2437)](https://github.com/stdlib-js/stdlib/pull/2437) _(by stdlib-bot, Athan Reines)_
Expand Down
4 changes: 2 additions & 2 deletions help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ acartesianPower,"\nacartesianPower( x, n )\n Returns the Cartesian power.\n\n
acartesianProduct,"\nacartesianProduct( x1, x2 )\n Returns the Cartesian product.\n\n If provided one or more empty arrays, the function returns an empty array.\n\n Parameters\n ----------\n x1: ArrayLikeObject\n First input array.\n\n x2: ArrayLikeObject\n Second input array.\n\n Returns\n -------\n out: Array<Array>\n Cartesian product.\n\n Examples\n --------\n > var x1 = [ 1, 2 ];\n > var x2 = [ 3, 4 ];\n > var out = acartesianProduct( x1, x2 )\n [ [ 1, 3 ], [ 1, 4 ], [ 2, 3 ], [ 2, 4 ] ]\n\n See Also\n --------\n acartesianPower, acartesianSquare\n"
acartesianSquare,"\nacartesianSquare( x )\n Returns the Cartesian square.\n\n If provided an empty array, the function returns an empty array.\n\n Parameters\n ----------\n x: ArrayLikeObject\n Input array.\n\n Returns\n -------\n out: Array<Array>\n Cartesian product.\n\n Examples\n --------\n > var out = acartesianSquare( [ 1, 2 ] )\n [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]\n\n See Also\n --------\n acartesianPower, acartesianProduct\n"
acronym,"\nacronym( str[, options] )\n Generates an acronym for a given string.\n\n Parameters\n ----------\n str: string\n Input string.\n\n options: Object (optional)\n Options.\n\n options.stopwords: Array<string> (optional)\n Array of custom stop words.\n\n Returns\n -------\n out: string\n Acronym for the given string.\n\n Examples\n --------\n > var out = acronym( 'the quick brown fox' )\n 'QBF'\n > out = acronym( 'Hard-boiled eggs' )\n 'HBE'\n"
aempty,"\naempty( length[, dtype] )\n Creates an uninitialized array having a specified length.\n\n In browser environments, the function always returns zero-filled arrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled array.\n\n In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n is *not* initialized. Memory contents are unknown and may contain\n *sensitive* data.\n\n The function supports the following data types:\n\n - float64: double-precision floating-point numbers (IEEE 754)\n - float32: single-precision floating-point numbers (IEEE 754)\n - complex128: double-precision complex floating-point numbers\n - complex64: single-precision complex floating-point numbers\n - int32: 32-bit two's complement signed integers\n - uint32: 32-bit unsigned integers\n - int16: 16-bit two's complement signed integers\n - uint16: 16-bit unsigned integers\n - int8: 8-bit two's complement signed integers\n - uint8: 8-bit unsigned integers\n - uint8c: 8-bit unsigned integers clamped to 0-255\n - generic: generic JavaScript values\n\n The default array data type is `float64`.\n\n Parameters\n ----------\n length: integer\n Array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = aempty( 2 )\n <Float64Array>\n > arr = aempty( 2, 'float32' )\n <Float32Array>\n\n See Also\n --------\n aemptyLike, afull, aones, azeros, ndempty\n"
aemptyLike,"\naemptyLike( x[, dtype] )\n Creates an uninitialized array having the same length and data type as a\n provided input array.\n\n In browser environments, the function always returns zero-filled arrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled array.\n\n In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n is *not* initialized. Memory contents are unknown and may contain\n *sensitive* data.\n\n The function supports the following data types:\n\n - float64: double-precision floating-point numbers (IEEE 754)\n - float32: single-precision floating-point numbers (IEEE 754)\n - complex128: double-precision complex floating-point numbers\n - complex64: single-precision complex floating-point numbers\n - int32: 32-bit two's complement signed integers\n - uint32: 32-bit unsigned integers\n - int16: 16-bit two's complement signed integers\n - uint16: 16-bit unsigned integers\n - int8: 8-bit two's complement signed integers\n - uint8: 8-bit unsigned integers\n - uint8c: 8-bit unsigned integers clamped to 0-255\n - generic: generic JavaScript values\n\n Parameters\n ----------\n x: TypedArray|Array\n Input array.\n\n dtype: string (optional)\n Data type. If not provided, the output array data type is inferred from\n the input array.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var x = new Float64Array( 2 );\n > var arr = aemptyLike( x )\n <Float64Array>\n > arr = aemptyLike( x, 'float32' )\n <Float32Array>\n\n See Also\n --------\n aempty, afullLike, aonesLike, azerosLike, ndemptyLike\n"
aempty,"\naempty( length[, dtype] )\n Creates an uninitialized array having a specified length.\n\n In browser environments, the function always returns zero-filled arrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled array.\n\n In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n is *not* initialized. Memory contents are unknown and may contain\n *sensitive* data.\n\n Parameters\n ----------\n length: integer\n Array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = aempty( 2 )\n <Float64Array>\n > arr = aempty( 2, 'float32' )\n <Float32Array>\n\n See Also\n --------\n aemptyLike, afull, aones, azeros, ndempty\n"
aemptyLike,"\naemptyLike( x[, dtype] )\n Creates an uninitialized array having the same length and data type as a\n provided input array.\n\n In browser environments, the function always returns zero-filled arrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled array.\n\n In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n is *not* initialized. Memory contents are unknown and may contain\n *sensitive* data.\n\n Parameters\n ----------\n x: TypedArray|Array\n Input array.\n\n dtype: string (optional)\n Data type. If not provided, the output array data type is inferred from\n the input array.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var x = new Float64Array( 2 );\n > var arr = aemptyLike( x )\n <Float64Array>\n > arr = aemptyLike( x, 'float32' )\n <Float32Array>\n\n See Also\n --------\n aempty, afullLike, aonesLike, azerosLike, ndemptyLike\n"
AFINN_96,"\nAFINN_96()\n Returns a list of English words rated for valence.\n\n The returned list contains 1468 English words (and phrases) rated for\n valence. Negative words have a negative valence [-5,0). Positive words have\n a positive valence (0,5]. Neutral words have a valence of 0.\n\n A few notes:\n\n - The list is an earlier version of AFINN-111.\n - The list includes misspelled words. Their presence is intentional, as such\n misspellings frequently occur in social media content.\n - All words are lowercase.\n - Some \"words\" are phrases; e.g., \"cashing in\", \"cool stuff\".\n - Words may contain apostrophes; e.g., \"can't stand\".\n - Words may contain dashes; e.g., \"cover-up\", \"made-up\".\n\n Returns\n -------\n out: Array<Array>\n List of English words and their valence.\n\n Examples\n --------\n > var list = AFINN_96()\n [ [ 'abandon', -2 ], [ 'abandons', -2 ], [ 'abandoned', -2 ], ... ]\n\n References\n ----------\n - Nielsen, Finn Årup. 2011. \"A new ANEW: Evaluation of a word list for\n sentiment analysis in microblogs.\" In *Proceedings of the ESWC2011 Workshop\n on 'Making Sense of Microposts': Big Things Come in Small Packages.*,\n 718:93–98. CEUR Workshop Proceedings. <http://ceur-ws.org/Vol-718/paper_16.\n pdf>.\n\n * If you use the list for publication or third party consumption, please\n cite the listed reference.\n\n See Also\n --------\n AFINN_111\n"
AFINN_111,"\nAFINN_111()\n Returns a list of English words rated for valence.\n\n The returned list contains 2477 English words (and phrases) rated for\n valence. Negative words have a negative valence [-5,0). Positive words have\n a positive valence (0,5]. Neutral words have a valence of 0.\n\n A few notes:\n\n - The list includes misspelled words. Their presence is intentional, as such\n misspellings frequently occur in social media content.\n - All words are lowercase.\n - Words may contain numbers; e.g., \"n00b\".\n - Some \"words\" are phrases; e.g., \"cool stuff\", \"not good\".\n - Words may contain apostrophes; e.g., \"can't stand\".\n - Words may contain diaeresis; e.g., \"naïve\".\n - Words may contain dashes; e.g., \"self-deluded\", \"self-confident\".\n\n Returns\n -------\n out: Array<Array>\n List of English words and their valence.\n\n Examples\n --------\n > var list = AFINN_111()\n [ [ 'abandon', -2 ], [ 'abandoned', -2 ], [ 'abandons', -2 ], ... ]\n\n References\n ----------\n - Nielsen, Finn Årup. 2011. \"A new ANEW: Evaluation of a word list for\n sentiment analysis in microblogs.\" In *Proceedings of the ESWC2011 Workshop\n on 'Making Sense of Microposts': Big Things Come in Small Packages.*,\n 718:93–98. CEUR Workshop Proceedings. <http://ceur-ws.org/Vol-718/paper_16.\n pdf>.\n\n * If you use the list for publication or third party consumption, please\n cite the listed reference.\n\n See Also\n --------\n AFINN_96\n"
afull,"\nafull( length, value[, dtype] )\n Returns a filled array having a specified length.\n\n Parameters\n ----------\n length: integer\n Array length.\n\n value: any\n Fill value.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = afull( 2, 1.0 )\n <Float64Array>[ 1.0, 1.0 ]\n > arr = afull( 2, 1.0, 'float32' )\n <Float32Array>[ 1.0, 1.0 ]\n\n See Also\n --------\n afullLike, aones, azeros\n"
Expand Down
2 changes: 1 addition & 1 deletion help/data/data.json

Large diffs are not rendered by default.

0 comments on commit adf0392

Please sign in to comment.