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
-[`ef082b9`](https://github.com/stdlib-js/stdlib/commit/ef082b94577dd75dcbd855e795bf22cf87cecf5e) - **fix:** update require to new location _(by Philipp Burckhardt)_
base.sargs2multislice,"var s = new base.sargs2multislice( 'null,null,null' );\ns.data\ns = new base.sargs2multislice( '10,Slice(0,10,1),null' );\ns.data\n"
1635
-
base.scalar2ndarray,"var x = base.scalar2ndarray( 1.0, 'float64', 'row-major' )\nvar sh = x.shape\nvar dt = x.dtype\nvar v = x.get()\n"
1635
+
base.scalar2ndarray,"var x = base.scalar2ndarray( 1.0, 'float64', 'row-major' )\nvar sh = ndarrayShape( x )\nvar v = x.get()\n"
1636
1636
base.secd,"var y = base.secd( 1.0 )\ny = base.secd( PI )\ny = base.secd( -PI )\ny = base.secd( NaN )\n"
1637
1637
base.seq2multislice,"var s = new base.seq2multislice( '1:10', [ 10 ], false );\ns.data\ns = new base.seq2multislice( '4,2:5:2,:', [ 10, 10, 10 ], false );\ns.data\n"
1638
1638
base.seq2slice,"var s = new base.seq2slice( '1:10', 10, false );\ns.start\ns.stop\ns.step\ns = new base.seq2slice( '2:5:2', 10, false );\ns.start\ns.stop\ns.step\n"
base.rsqrt,"\nbase.rsqrt( x )\n Computes the reciprocal square root of a double-precision floating-point\n number.\n\n For `x < 0`, the reciprocal square root is not defined.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Reciprocal square root.\n\n Examples\n --------\n > var y = base.rsqrt( 4.0 )\n 0.5\n > y = base.rsqrt( 100.0 )\n 0.1\n > y = base.rsqrt( 0.0 )\n Infinity\n > y = base.rsqrt( Infinity )\n 0.0\n > y = base.rsqrt( -4.0 )\n NaN\n > y = base.rsqrt( NaN )\n NaN\n\n See Also\n --------\n base.sqrt\n"
1633
1633
base.rsqrtf,"\nbase.rsqrtf( x )\n Computes the reciprocal square root of a single-precision floating-point\n number.\n\n For `x < 0`, the reciprocal square root is not defined.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Reciprocal square root.\n\n Examples\n --------\n > var y = base.rsqrtf( 4.0 )\n 0.5\n > y = base.rsqrtf( 0.0 )\n Infinity\n > y = base.rsqrtf( Infinity )\n 0.0\n > y = base.rsqrtf( -4.0 )\n NaN\n > y = base.rsqrtf( NaN )\n NaN\n\n See Also\n --------\n base.rsqrt, base.sqrtf\n"
1634
1634
base.sargs2multislice,"\nbase.sargs2multislice( str )\n Creates a MultiSlice object from a comma-separated list of string-serialized\n MultiSlice constructor arguments.\n\n The function returns `null` if provided an invalid string.\n\n Parameters\n ----------\n str: string\n Input string containing constructor arguments.\n\n Returns\n -------\n s: MultiSlice|null\n MultiSlice instance (or null).\n\n Examples\n --------\n > var s = new base.sargs2multislice( 'null,null,null' );\n > s.data\n [ null, null, null ]\n > s = new base.sargs2multislice( '10,Slice(0,10,1),null' );\n > s.data\n [ 10, <Slice>, null ]\n\n See Also\n --------\n base.args2multislice, base.seq2multislice\n"
1635
-
base.scalar2ndarray,"\nbase.scalar2ndarray( value, dtype, order )\n Returns a zero-dimensional ndarray 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 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 dtype: string\n Data type.\n\n order: string\n Memory layout (either 'row-major' or 'column-major').\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var x = base.scalar2ndarray( 1.0, 'float64', 'row-major' )\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, base.ndarray, ndarray\n"
1635
+
base.scalar2ndarray,"\nbase.scalar2ndarray( value, dtype, order )\n Returns a zero-dimensional ndarray 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 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 dtype: string|DataType\n Data type.\n\n order: string\n Memory layout (either 'row-major' or 'column-major').\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var x = base.scalar2ndarray( 1.0, 'float64', 'row-major' )\n <ndarray>\n > var sh = ndarrayShape( x )\n []\n > var v = x.get()\n 1.0\n\n See Also\n --------\n array, base.ndarray, ndarray\n"
1636
1636
base.secd,"\nbase.secd( x )\n Computes the secant of an angle measured in degrees.\n\n Parameters\n ----------\n x: number\n Input value (in degrees).\n\n Returns\n -------\n y: number\n Secant.\n\n Examples\n --------\n > var y = base.secd( 1.0 )\n ~1.0\n > y = base.secd( PI )\n ~1.0\n > y = base.secd( -PI )\n ~1.0\n > y = base.secd( NaN )\n NaN\n\n See Also\n --------\n base.cosd, base.cos\n"
1637
1637
base.seq2multislice,"\nbase.seq2multislice( str, shape, strict )\n Converts a multidimensional subsequence string to a MultiSlice object.\n\n A multidimensional subsequence string is a comma-separated list of single-\n dimension indexing expressions (i.e., integers and/or subsequence strings).\n\n For example, the following\n\n 2\n :\n 2:\n :10\n 2:10\n ::-1\n 10:2:-1\n :2:\n 2:10:\n 2::2\n :10:2\n :, :, :\n 1, 2, 3\n 0:10, 1:20:2, ::-1\n ...\n :, ..., 2\n\n are all valid multidimensional subsequence strings.\n\n Providing a single nonnegative integer `i` as a single-dimension index\n indexes the same elements as the subsequence `i:i+1`.\n\n Providing a single negative integer `i` as a single-dimension index indexes\n the same elements as the subsequence `n+i:n+i+i`, where `n` is the dimension\n size.\n\n While integers index the same elements as equivalent subsequences, providing\n an integer as a single-dimension index indicates to reduce the number of\n dimensions by one (e.g., if the provided shape corresponds to an array\n having rank 2, then rank(A)-1 == rank(A['0,:'])).\n\n In contrast, providing a subsequence indicates to retain a respective\n dimension (e.g., if the provided shape corresponds to an array having rank\n 2, then rank(A) == rank(A[':,:'])).\n\n A multidimensional subsequence string can only contain **one** ellipsis\n ('...') operator. An ellipsis indicates to apply ':' to each dimension\n necessary to index all dimensions (e.g., if A has rank 4, A['1:,...,2:5']\n equals A['1:,:,:,2:5']).\n\n Except in the case of providing a single ellipsis, the number of single-\n dimension indexing expressions must equal the number of dimensions in the\n input shape.\n\n The function returns an error object if provided an invalid subsequence\n string.\n\n In strict mode, the function returns an error object if a single-dimension\n index expression which exceeds index bounds.\n\n A returned error object is a plain object having the following properties:\n\n - code: error code.\n\n A returned error object may have one of the following error codes:\n\n - ERR_SLICE_INVALID_SUBSEQUENCE: a subsequence string is invalid.\n - ERR_SLICE_INVALID_INCREMENT: a subsequence string must have a non-zero\n increment.\n - ERR_SLICE_OUT_OF_BOUNDS: a subsequence string resolves to a slice\n exceeding index bounds.\n - ERR_SLICE_TOO_MANY_DIMENSIONS: a subsequence string has more dimensions\n than the provided shape.\n - ERR_SLICE_INSUFFICIENT_DIMENSIONS: a subsequence string has too few\n dimensions.\n - ERR_SLICE_INVALID_ELLIPSIS: a subsequence string must only contain at most\n one ellipsis.\n\n Parameters\n ----------\n str: string\n Subsequence string.\n\n shape: Array<integer>\n Maximum allowed slice shape.\n\n strict: boolean\n Boolean indicating whether to enforce strict bounds checking.\n\n Returns\n -------\n s: MultiSlice|Object\n MultiSlice instance or an error object.\n\n Examples\n --------\n > var s = new base.seq2multislice( '1:10', [ 10 ], false );\n > s.data\n [ <Slice> ]\n > s = new base.seq2multislice( '4,2:5:2,:', [ 10, 10, 10 ], false );\n > s.data\n [ 4, <Slice>, <Slice> ]\n\n See Also\n --------\n base.seq2slice, base.sargs2multislice\n"
1638
1638
base.seq2slice,"\nbase.seq2slice( str, len, strict )\n Converts a subsequence string to a Slice object.\n\n A subsequence string has the following format:\n\n <start>:<stop>:<increment>\n\n If an increment is not specified, the default increment is one. An increment\n of zero is not allowed.\n\n The start index is inclusive.\n\n The stop index is exclusive.\n\n Both start and stop indices are optional. If not provided, the start and\n stop indices default to index extremes. Which extremes correspond to which\n index depends on whether the increment is positive or negative.\n\n Both start and stop indices can be negative; in which case, the\n corresponding index is resolved by subtracting the respective value from the\n provided length.\n\n Both start and stop indices can use the 'end' keyword (e.g., 'end-2::2',\n 'end-3:', etc), which supports basic subtraction and division.\n\n The 'end' keyword resolves to the provided length. Thus, ':-1' is equivalent\n to ':end-1', ':-2' is equivalent to ':end-2', and so on and so forth. The\n exception is when performing a division operation when the increment is less\n than zero; in which case, 'end' is equal to 'len-1' in order to preserve\n user expectations when 'end/d' equals a whole number and slicing from right-\n to-left. The result from a division operation is rounded down to the nearest\n integer value.\n\n In non-strict mode, the resolved slice start is clamped to the slice index\n bounds [0, len).\n\n In non-strict mode, Tte resolved slice end is upper bound clamped to the\n provided length (i.e., one greater than the last possible index).\n\n When the increment is negative, the resolved slice end value may be `null`,\n thus indicating that a non-empty slice should include the first index.\n\n The function ensures that results satisfy the convention that ':n' combined\n with 'n:' is equivalent to ':' (i.e., selecting all elements).\n\n When the provided length is zero, the function always returns a slice object\n equivalent to '0:0:<increment>'.\n\n The function returns an error object if provided an invalid subsequence\n string.\n\n In strict mode, the function returns an error object if provided a\n subsequence string which exceeds index bounds.\n\n A returned error object is a plain object having the following properties:\n\n - code: error code.\n\n A returned error object may have one of the following error codes:\n\n - ERR_SLICE_INVALID_SUBSEQUENCE: a subsequence string is invalid.\n - ERR_SLICE_INVALID_INCREMENT: a subsequence string must have a non-zero\n increment.\n - ERR_SLICE_OUT_OF_BOUNDS: a subsequence string resolves to a slice\n exceeding index bounds.\n\n Parameters\n ----------\n str: string\n Subsequence string.\n\n len: integer\n Maximum number of elements allowed in the slice.\n\n strict: boolean\n Boolean indicating whether to enforce strict bounds checking.\n\n Returns\n -------\n s: Slice|Object\n Slice instance or an error object.\n\n Examples\n --------\n > var s = new base.seq2slice( '1:10', 10, false );\n > s.start\n 1\n > s.stop\n 10\n > s.step\n 1\n > s = new base.seq2slice( '2:5:2', 10, false );\n > s.start\n 2\n > s.stop\n 5\n > s.step\n 2\n\n See Also\n --------\n base.seq2multislice, base.slice2seq\n"
Copy file name to clipboardExpand all lines: info/data/data.csv
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1632,7 +1632,7 @@ base.roundsd,"\nbase.roundsd( x:number, n:integer[, b:integer] )\n Rounds a d
1632
1632
base.rsqrt,"\nbase.rsqrt( x:number )\n Computes the reciprocal square root of a double-precision floating-point\n number.\n"
1633
1633
base.rsqrtf,"\nbase.rsqrtf( x:number )\n Computes the reciprocal square root of a single-precision floating-point\n number.\n"
1634
1634
base.sargs2multislice,"\nbase.sargs2multislice( str:string )\n Creates a MultiSlice object from a comma-separated list of string-serialized\n MultiSlice constructor arguments.\n"
1635
-
base.scalar2ndarray,"\nbase.scalar2ndarray( value:any, dtype:string, order:string )\n Returns a zero-dimensional ndarray containing a provided scalar value.\n"
1635
+
base.scalar2ndarray,"\nbase.scalar2ndarray( value:any, dtype:string|DataType, order:string )\n Returns a zero-dimensional ndarray containing a provided scalar value.\n"
1636
1636
base.secd,"\nbase.secd( x:number )\n Computes the secant of an angle measured in degrees.\n"
1637
1637
base.seq2multislice,"\nbase.seq2multislice( str:string, shape:Array<integer>, strict:boolean )\n Converts a multidimensional subsequence string to a MultiSlice object.\n"
1638
1638
base.seq2slice,"\nbase.seq2slice( str:string, len:integer, strict:boolean )\n Converts a subsequence string to a Slice object.\n"
0 commit comments