Skip to content

Commit d82186f

Browse files
kgrytestdlib-bot
authored andcommitted
docs: update REPL namespace documentation
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent f766a56 commit d82186f

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4988,7 +4988,7 @@ SAVOY_STOPWORDS_POR,"\nSAVOY_STOPWORDS_POR()\n Returns a list of Portuguese s
49884988
SAVOY_STOPWORDS_SP,"\nSAVOY_STOPWORDS_SP()\n Returns a list of Spanish stop words.\n\n Returns\n -------\n out: Array<string>\n List of stop words.\n\n Examples\n --------\n > var list = SAVOY_STOPWORDS_SP()\n [ 'a', 'acuerdo', 'adelante', 'ademas', ... ]\n\n References\n ----------\n - Savoy, Jacques. 2005. \"IR Multilingual Resources at UniNE.\"\n <http://members.unine.ch/jacques.savoy/clef/>.\n\n"
49894989
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"
49904990
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"
4991-
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 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"
4991+
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"
49924992
sdot,"\nsdot( x, y )\n Computes the dot product of two single-precision floating-point vectors.\n\n If provided empty vectors, the function returns `0.0`.\n\n Parameters\n ----------\n x: ndarray\n First input array whose underlying data type is 'float32'.\n\n y: ndarray\n Second input array whose underlying data type is 'float32'.\n\n Returns\n -------\n dot: number\n The dot product.\n\n Examples\n --------\n > var x = array( new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );\n > var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );\n > sdot( x, y )\n -5.0\n\n See Also\n --------\n base.strided.sdot, ddot, gdot\n"
49934993
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"
49944994
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"

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)