Skip to content

Commit 3ae26e4

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #11636 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 194227f commit 3ae26e4

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5105,7 +5105,7 @@ SAVOY_STOPWORDS_SP,"var list = SAVOY_STOPWORDS_SP()\n"
51055105
SAVOY_STOPWORDS_SWE,"var list = SAVOY_STOPWORDS_SWE()\n"
51065106
scalar2array,"var x = scalar2array( 1.0 )\n"
51075107
scalar2ndarray,"var x = scalar2ndarray( 1.0 )\nvar sh = x.shape\nvar dt = x.dtype\nvar v = x.get()\n"
5108-
sdot,"var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar x = array( xbuf );\nvar ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\nvar y = array( ybuf );\nvar z = sdot( x, y )\nz.get()\n"
5108+
sdot,"var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar x = array( xbuf );\nvar ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\nvar y = array( ybuf );\nvar z = sdot( x, y )\n"
51095109
SECONDS_IN_DAY,"var days = 3.14;\nvar secs = days * SECONDS_IN_DAY\n"
51105110
SECONDS_IN_HOUR,"var hrs = 3.14;\nvar secs = hrs * SECONDS_IN_HOUR\n"
51115111
SECONDS_IN_MINUTE,"var mins = 3.14;\nvar secs = mins * SECONDS_IN_MINUTE\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5107,7 +5107,7 @@ SAVOY_STOPWORDS_SP,"\nSAVOY_STOPWORDS_SP()\n Returns a list of Spanish stop w
51075107
SAVOY_STOPWORDS_SWE,"\nSAVOY_STOPWORDS_SWE()\n Returns a list of Swedish stop words.\n\n Returns\n -------\n out: Array<string>\n List of stop words.\n\n Examples\n --------\n > var list = SAVOY_STOPWORDS_SWE()\n [ 'aderton', 'adertonde', 'adjö', ... ]\n\n References\n ----------\n - Savoy, Jacques. 2005. \"IR Multilingual Resources at UniNE.\"\n <http://members.unine.ch/jacques.savoy/clef/>.\n\n"
51085108
scalar2array,"\nscalar2array( value[, dtype] )\n Returns a single-element array containing a provided scalar value.\n\n If `value` is a number and `dtype` is a complex number data type, the\n function returns a complex number array containing a complex number whose\n real component equals the provided scalar value and whose imaginary\n component is zero.\n\n Parameters\n ----------\n value: any\n Scalar value.\n\n dtype: string (optional)\n Data type. If not provided and `value`\n\n - is a number, the default data type is the default real-valued\n floating-point data type.\n - is a boolean, the default data type is the default boolean data type.\n - is a complex number object of a known complex data type, the data type\n is the same as the provided value.\n - is a complex number object of an unknown data type, the default data\n type is the default complex-valued floating-point data type.\n - is any other value type, the default data type is 'generic'.\n\n Returns\n -------\n out: Array|TypedArray\n Output array.\n\n Examples\n --------\n > var x = scalar2array( 1.0 )\n <Float64Array>[ 1.0 ]\n\n See Also\n --------\n iterator2array\n"
51095109
scalar2ndarray,"\nscalar2ndarray( value[, options] )\n Returns a zero-dimensional ndarray containing a provided scalar value.\n\n If `value` is a number and `options.dtype` is a complex number data type,\n the function returns a zero-dimensional ndarray containing a complex number\n whose real component equals the provided scalar value and whose imaginary\n component is zero.\n\n Parameters\n ----------\n value: any\n Scalar value.\n\n options: Object (optional)\n Options.\n\n options.dtype: string (optional)\n Data type. If not provided and `value`\n\n - is a number, the default data type is the default real-valued\n floating-point data type.\n - is a boolean, the default data type is the default boolean data type.\n - is a complex number object of a known complex data type, the data type\n is the same as the provided value.\n - is a complex number object of an unknown data type, the default data\n type is the default complex-valued floating-point data type.\n - is any other value type, the default data type is 'generic'.\n\n options.order: string (optional)\n Specifies whether an array is row-major (C-style) or column-major\n (Fortran-style). Default: 'row-major'.\n\n options.readonly: boolean (optional)\n Boolean indicating whether an array should be read-only. Default: false.\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var x = scalar2ndarray( 1.0 )\n <ndarray>\n > var sh = x.shape\n []\n > var dt = x.dtype\n 'float64'\n > var v = x.get()\n 1.0\n\n See Also\n --------\n array, ndarray\n"
5110-
sdot,"\nsdot( x, y[, dim] )\n Computes the dot product of two single-precision floating-point vectors.\n\n If provided at least one input array having more than one dimension, the\n input arrays are broadcasted to a common shape.\n\n For multi-dimensional input arrays, the function performs batched\n computation, such that the function computes the dot product for each pair\n of vectors in `x` and `y` according to the specified dimension index.\n\n The size of the contracted dimension must be the same for both input arrays.\n\n The function resolves the dimension index for which to compute the dot\n product *before* broadcasting.\n\n If provided empty vectors, the dot product is `0`.\n\n Parameters\n ----------\n x: ndarray\n First input array. Must have a 'float32' data type. Must have at least\n one dimension and be broadcast-compatible with the second input array.\n\n y: ndarray\n Second input array. Must have a 'float32' data type. Must have at least\n one dimension and be broadcast-compatible with the first input array.\n\n dim: integer (optional)\n Dimension index for which to compute the dot product. Must be a negative\n integer. Negative indices are resolved relative to the last array\n dimension, with the last dimension corresponding to `-1`. Default: -1.\n\n Returns\n -------\n out: ndarray\n The dot product. The output array has the same data type as the input\n arrays and has a shape which is determined by broadcasting and excludes\n the contracted dimension.\n\n Examples\n --------\n > var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\n > var x = array( xbuf );\n > var ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n > var y = array( ybuf );\n > var z = sdot( x, y )\n <ndarray>\n > z.get()\n -5.0\n\n See Also\n --------\n base.strided.sdot, ddot, gdot\n"
5110+
sdot,"\nsdot( x, y[, dim] )\n Computes the dot product of two single-precision floating-point vectors.\n\n If provided at least one input array having more than one dimension, the\n input arrays are broadcasted to a common shape.\n\n For multi-dimensional input arrays, the function performs batched\n computation, such that the function computes the dot product for each pair\n of vectors in `x` and `y` according to the specified dimension index.\n\n The size of the contracted dimension must be the same for both input arrays.\n\n The function resolves the dimension index for which to compute the dot\n product *before* broadcasting.\n\n If provided empty vectors, the dot product is `0`.\n\n Parameters\n ----------\n x: ndarray\n First input array. Must have a 'float32' data type. Must have at least\n one dimension and be broadcast-compatible with the second input array.\n\n y: ndarray\n Second input array. Must have a 'float32' data type. Must have at least\n one dimension and be broadcast-compatible with the first input array.\n\n dim: integer (optional)\n Dimension index for which to compute the dot product. Must be a negative\n integer. Negative indices are resolved relative to the last array\n dimension, with the last dimension corresponding to `-1`. Default: -1.\n\n Returns\n -------\n out: ndarray\n The dot product. The output array has the same data type as the input\n arrays and has a shape which is determined by broadcasting and excludes\n the contracted dimension.\n\n Examples\n --------\n > var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\n > var x = array( xbuf );\n > var ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n > var y = array( ybuf );\n > var z = sdot( x, y )\n <ndarray>[ -5.0 ]\n\n See Also\n --------\n base.strided.sdot, ddot, gdot\n"
51115111
SECONDS_IN_DAY,"\nSECONDS_IN_DAY\n Number of seconds in a day.\n\n The value is a generalization and does **not** take into account\n inaccuracies due to daylight savings conventions, crossing timezones, or\n other complications with time and dates.\n\n Examples\n --------\n > var days = 3.14;\n > var secs = days * SECONDS_IN_DAY\n 271296\n\n"
51125112
SECONDS_IN_HOUR,"\nSECONDS_IN_HOUR\n Number of seconds in an hour.\n\n The value is a generalization and does **not** take into account\n inaccuracies due to daylight savings conventions, crossing timezones, or\n other complications with time and dates.\n\n Examples\n --------\n > var hrs = 3.14;\n > var secs = hrs * SECONDS_IN_HOUR\n 11304\n\n"
51135113
SECONDS_IN_MINUTE,"\nSECONDS_IN_MINUTE\n Number of seconds in a minute.\n\n The value is a generalization and does **not** take into account\n inaccuracies arising due to complications with time and dates.\n\n Examples\n --------\n > var mins = 3.14;\n > var secs = mins * SECONDS_IN_MINUTE\n 188.4\n\n"

lib/node_modules/@stdlib/repl/help/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)