Skip to content

Commit 1b0e26f

Browse files
committed
Update namespace
1 parent 6ebb543 commit 1b0e26f

File tree

3 files changed

+14
-0
lines changed
  • lib/node_modules/@stdlib

3 files changed

+14
-0
lines changed

lib/node_modules/@stdlib/namespace/lib/namespace/n.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,18 @@ ns.push({
9191
]
9292
});
9393

94+
ns.push({
95+
'alias': 'ndarrayNextDataType',
96+
'path': '@stdlib/ndarray/next-dtype',
97+
'value': require( '@stdlib/ndarray/next-dtype' ),
98+
'type': 'Function',
99+
'related': [
100+
'@stdlib/ndarray/dtypes',
101+
'@stdlib/ndarray/promotion-rules',
102+
'@stdlib/ndarray/safe-casts'
103+
]
104+
});
105+
94106
ns.push({
95107
'alias': 'ndarrayOrders',
96108
'path': '@stdlib/ndarray/orders',

lib/node_modules/@stdlib/repl/code-blocks/lib/db.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,6 +1314,7 @@ var db = {
13141314
"ndarrayDataTypes": "out = ndarrayDataTypes()\n",
13151315
"ndarrayIndexModes": "out = ndarrayIndexModes()\n",
13161316
"ndarrayMemoized": "ctor = ndarrayMemoized( 'generic', 3 )\nf = ndarrayMemoized( 'generic', 3 )\nbool = ( f === ctor )\n\n// To create a new instance...\nb = [ 1.0, 2.0, 3.0, 4.0 ]; // underlying data buffer\nd = [ 2, 2 ]; // shape\ns = [ 2, 1 ]; // strides\no = 0; // index offset\narr = ctor( b, d, s, o, 'row-major' )\n\n// Get an element using subscripts:\nv = arr.get( 1, 1 )\n\n// Get an element using a linear index:\nv = arr.iget( 3 )\n\n// Set an element using subscripts:\narr.set( 1, 1, 40.0 );\narr.get( 1, 1 )\n\n// Set an element using a linear index:\narr.iset( 3, 99.0 );\narr.get( 1, 1 )\n",
1317+
"ndarrayNextDataType": "out = ndarrayNextDataType( 'float32' )\n",
13171318
"ndarrayOrders": "out = ndarrayOrders()\n",
13181319
"ndarrayPromotionRules": "out = ndarrayPromotionRules( 'float32', 'int32' )\n",
13191320
"ndarraySafeCasts": "out = ndarraySafeCasts( 'float32' )\n",

lib/node_modules/@stdlib/repl/help/lib/db.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1315,6 +1315,7 @@ var db = {
13151315
"ndarrayDataTypes": "\nndarrayDataTypes()\n Returns a list of ndarray data types.\n\n The output array contains the following data types:\n\n - binary: binary.\n - float32: single-precision floating-point numbers.\n - float64: double-precision floating-point numbers.\n - generic: values of any type.\n - int16: signed 16-bit integers.\n - int32: signed 32-bit integers.\n - int8: signed 8-bit integers.\n - uint16: unsigned 16-bit integers.\n - uint32: unsigned 32-bit integers.\n - uint8: unsigned 8-bit integers.\n - uint8c: unsigned clamped 8-bit integers.\n\n Returns\n -------\n out: Array<string>\n List of ndarray data types.\n\n Examples\n --------\n > var out = ndarrayDataTypes()\n <Array>\n\n See Also\n --------\n arrayDataTypes, array, ndarray, typedarrayDataTypes\n",
13161316
"ndarrayIndexModes": "\nndarrayIndexModes()\n Returns a list of ndarray index modes.\n\n The output array contains the following modes:\n\n - throw: specifies that a function should throw an error when an index is\n outside a restricted interval.\n - wrap: specifies that a function should wrap around an index using modulo\n arithmetic.\n - clamp: specifies that a function should set an index less than zero to\n zero (minimum index) and set an index greater than a maximum index value to\n the maximum possible index.\n\n Returns\n -------\n out: Array<string>\n List of ndarray index modes.\n\n Examples\n --------\n > var out = ndarrayIndexModes()\n [ 'throw', 'clamp', 'wrap' ]\n\n See Also\n --------\n array, ndarray\n",
13171317
"ndarrayMemoized": "\nndarrayMemoized( dtype, ndims[, options] )\n Returns a memoized ndarray constructor.\n\n Parameters\n ----------\n dtype: string\n Underlying data type.\n\n ndims: integer\n Number of dimensions.\n\n options: Object (optional)\n Options.\n\n options.codegen: boolean (optional)\n Boolean indicating whether to use code generation. Code generation can\n boost performance, but may be problematic in browser contexts enforcing\n a strict content security policy (CSP). Default: true.\n\n options.mode: string (optional)\n Specifies how to handle indices which exceed array dimensions. If equal\n to 'throw', an ndarray instance throws an error when an index exceeds\n array dimensions. If equal to 'wrap', an ndarray instance wraps around\n indices exceeding array dimensions using modulo arithmetic. If equal to\n 'clamp', an ndarray instance sets an index exceeding array dimensions to\n either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n options.submode: Array<string> (optional)\n Specifies how to handle subscripts which exceed array dimensions. If a\n mode for a corresponding dimension is equal to 'throw', an ndarray\n instance throws an error when a subscript exceeds array dimensions. If\n equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n array dimensions using modulo arithmetic. If equal to 'clamp', an\n ndarray instance sets a subscript exceeding array dimensions to either\n `0` (minimum index) or the maximum index. If the number of modes is\n fewer than the number of dimensions, the function recycles modes using\n modulo arithmetic. Default: [ options.mode ].\n\n Returns\n -------\n ctor: Function\n Memoized ndarray constructor.\n\n ctor.BYTES_PER_ELEMENT: integer\n Size (in bytes) of each array element (if known).\n\n ctor.dtype: string\n Underlying data type.\n\n ctor.ndims: integer\n Number of dimensions.\n\n ctor.prototype.byteLength: integer\n Size (in bytes) of the array (if known).\n\n ctor.prototype.BYTES_PER_ELEMENT: integer\n Size (in bytes) of each array element (if known).\n\n ctor.prototype.data: ArrayLikeObject|TypedArray|Buffer\n Pointer to the underlying data buffer.\n\n ctor.prototype.dtype: string\n Underlying data type.\n\n ctor.prototype.flags: Object\n Information about the memory layout of the array.\n\n ctor.prototype.length: integer\n Length of the array (i.e., number of elements).\n\n ctor.prototype.ndims: integer\n Number of dimensions.\n\n ctor.prototype.offset: integer\n Index offset which specifies the buffer index at which to start\n iterating over array elements.\n\n ctor.prototype.order: string\n Array order. The array order is either row-major (C-style) or column-\n major (Fortran-style).\n\n ctor.prototype.shape: Array\n Array shape.\n\n ctor.prototype.strides: Array\n Index strides which specify how to access data along corresponding array\n dimensions.\n\n ctor.prototype.get: Function\n Returns an array element specified according to provided subscripts. The\n number of provided subscripts should equal the number of dimensions.\n\n ctor.prototype.iget: Function\n Returns an array element located at a specified linear index.\n\n ctor.prototype.set: Function\n Sets an array element specified according to provided subscripts. The\n number of provided subscripts should equal the number of dimensions.\n\n ctor.prototype.iset: Function\n Sets an array element located at a specified linear index.\n\n ctor.prototype.toString: Function\n Serializes an ndarray as a string. This method does **not** serialize\n data outside of the buffer region defined by the array configuration.\n\n ctor.prototype.toJSON: Function\n Serializes an ndarray as a JSON object. This method does **not**\n serialize data outside of the buffer region defined by the array\n configuration.\n\n Examples\n --------\n > var ctor = ndarrayMemoized( 'generic', 3 )\n <Function>\n > var f = ndarrayMemoized( 'generic', 3 )\n <Function>\n > var bool = ( f === ctor )\n true\n\n // To create a new instance...\n > var b = [ 1.0, 2.0, 3.0, 4.0 ]; // underlying data buffer\n > var d = [ 2, 2 ]; // shape\n > var s = [ 2, 1 ]; // strides\n > var o = 0; // index offset\n > var arr = ctor( b, d, s, o, 'row-major' )\n <ndarray>\n\n // Get an element using subscripts:\n > var v = arr.get( 1, 1 )\n 4.0\n\n // Get an element using a linear index:\n > v = arr.iget( 3 )\n 4.0\n\n // Set an element using subscripts:\n > arr.set( 1, 1, 40.0 );\n > arr.get( 1, 1 )\n 40.0\n\n // Set an element using a linear index:\n > arr.iset( 3, 99.0 );\n > arr.get( 1, 1 )\n 99.0\n\n See Also\n --------\n array, ndarray\n",
1318+
"ndarrayNextDataType": "\nndarrayNextDataType( [dtype] )\n Returns the next larger ndarray data type of the same kind.\n\n If not provided a data type, the function returns a table.\n\n If a data type does not have a next larger data type or the next larger type\n is not supported, the function returns `-1`.\n\n If provided an unrecognized data type, the function returns `null`.\n\n Parameters\n ----------\n dtype: string (optional)\n ndarray data type.\n\n Returns\n -------\n out: Object|string|null\n Next larger type(s).\n\n Examples\n --------\n > var out = ndarrayNextDataType( 'float32' )\n 'float64'\n\n See Also\n --------\n ndarrayDataTypes, ndarrayPromotionRules, ndarraySafeCasts\n",
13181319
"ndarrayOrders": "\nndarrayOrders()\n Returns a list of ndarray orders.\n\n The output array contains the following orders:\n\n - row-major: row-major (C-style) order.\n - column-major: column-major (Fortran-style) order.\n\n Returns\n -------\n out: Array<string>\n List of ndarray orders.\n\n Examples\n --------\n > var out = ndarrayOrders()\n [ 'row-major', 'column-major' ]\n\n See Also\n --------\n array, ndarray\n",
13191320
"ndarrayPromotionRules": "\nndarrayPromotionRules( [dtype1, dtype2] )\n Returns the ndarray data type with the smallest size and closest \"kind\" to\n which ndarray data types can be safely cast.\n\n If not provided data types, the function returns a type promotion table.\n\n If a data type to which data types can be safely cast does *not* exist (or\n is not supported), the function returns `-1`.\n\n If provided an unrecognized data type, the function returns `null`.\n\n Parameters\n ----------\n dtype1: string (optional)\n ndarray data type.\n\n dtype2: string (optional)\n ndarray data type.\n\n Returns\n -------\n out: Object|string|integer|null\n Promotion rule(s).\n\n Examples\n --------\n > var out = ndarrayPromotionRules( 'float32', 'int32' )\n 'float64'\n\n See Also\n --------\n ndarrayCastingModes, ndarrayDataTypes, ndarraySafeCasts\n",
13201321
"ndarraySafeCasts": "\nndarraySafeCasts( [dtype] )\n Returns a list of ndarray data types to which a provided ndarray data type\n can be safely cast.\n\n If not provided an ndarray data type, the function returns a casting table.\n\n If provided an unrecognized ndarray data type, the function returns `null`.\n\n Parameters\n ----------\n dtype: string (optional)\n ndarray data type.\n\n Returns\n -------\n out: Object|Array<string>|null\n ndarray data types to which a data type can be safely cast.\n\n Examples\n --------\n > var out = ndarraySafeCasts( 'float32' )\n <Array>\n\n See Also\n --------\n ndarrayCastingModes, ndarrayDataTypes, ndarraySameKindCasts\n",

0 commit comments

Comments
 (0)