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 Dec 2, 2023
1 parent cc2cd9e commit 61b7ad6
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 8 deletions.
1 change: 1 addition & 0 deletions code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3696,6 +3696,7 @@ ndarrayPromotionRules,"var out = ndarrayPromotionRules( 'float32', 'int32' )\n"
ndarraySafeCasts,"var out = ndarraySafeCasts( 'float32' )\n"
ndarraySameKindCasts,"var out = ndarraySameKindCasts( 'float32' )\n"
ndarrayShape,"var out = ndarrayShape( ndzeros( [ 3, 3, 3 ] ) )\n"
ndarrayStride,"var out = ndarrayStride( ndzeros( [ 3, 3, 3 ] ), 0 )\n"
ndarrayStrides,"var out = ndarrayStrides( ndzeros( [ 3, 3, 3 ] ) )\n"
ndempty,"var arr = ndempty( [ 2, 2 ] )\nvar sh = arr.shape\nvar dt = arr.dtype\n"
ndemptyLike,"var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\nvar sh = x.shape\nvar dt = x.dtype\nvar y = ndemptyLike( x )\nsh = y.shape\ndt = y.dtype\n"
Expand Down
2 changes: 1 addition & 1 deletion code-blocks/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/index.js.map

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3066,8 +3066,14 @@ isCollection,"\nisCollection( value )\n Tests if a value is a collection.\n\n
isComplex,"\nisComplex( value )\n Tests if a value is a 64-bit or 128-bit complex number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 64-bit or 128-bit complex\n number.\n\n Examples\n --------\n > var bool = isComplex( new Complex64( 2.0, 2.0 ) )\n true\n > bool = isComplex( new Complex128( 3.0, 1.0 ) )\n true\n > bool = isComplex( 3.14 )\n false\n > bool = isComplex( {} )\n false\n\n See Also\n --------\n isComplex64, isComplex128\n"
isComplex64,"\nisComplex64( value )\n Tests if a value is a 64-bit complex number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 64-bit complex number.\n\n Examples\n --------\n > var bool = isComplex64( new Complex64( 2.0, 2.0 ) )\n true\n > bool = isComplex64( new Complex128( 3.0, 1.0 ) )\n false\n > bool = isComplex64( 3.14 )\n false\n > bool = isComplex64( {} )\n false\n\n See Also\n --------\n isComplex, isComplex128\n"
isComplex64Array,"\nisComplex64Array( value )\n Tests if a value is a Complex64Array.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a Complex64Array.\n\n Examples\n --------\n > var bool = isComplex64Array( new Complex64Array( 10 ) )\n true\n > bool = isComplex64Array( [] )\n false\n\n See Also\n --------\n isComplex, isComplex64, isComplex128Array, isComplexTypedArray\n"
isComplex64MatrixLike,"\nisComplex64MatrixLike( value )\n Tests if a value is a 2-dimensional ndarray-like object containing single-\n precision complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 2-dimensional ndarray-like\n object containing single-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex64';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex64MatrixLike( M )\n true\n > bool = isComplex64MatrixLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex64MatrixLike( 3.14 )\n false\n > bool = isComplex64MatrixLike( {} )\n false\n\n See Also\n --------\n isndarrayLike, isMatrixLike\n"
isComplex64ndarrayLike,"\nisComplex64ndarrayLike( value )\n Tests if a value is an ndarray-like object containing single-precision\n complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an ndarray-like object containing\n single-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex64';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex64ndarrayLike( M )\n true\n > bool = isComplex64ndarrayLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex64ndarrayLike( 3.14 )\n false\n > bool = isComplex64ndarrayLike( {} )\n false\n\n See Also\n --------\n isndarrayLike\n"
isComplex64VectorLike,"\nisComplex64VectorLike( value )\n Tests if a value is a 1-dimensional ndarray-like object containing single-\n precision complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 1-dimensional ndarray-like\n object containing single-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 1;\n > M.shape = [ 4 ];\n > M.strides = [ 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex64';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex64VectorLike( M )\n true\n > bool = isComplex64VectorLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex64VectorLike( 3.14 )\n false\n > bool = isComplex64VectorLike( {} )\n false\n\n See Also\n --------\n isndarrayLike, isVectorLike\n"
isComplex128,"\nisComplex128( value )\n Tests if a value is a 128-bit complex number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 128-bit complex number.\n\n Examples\n --------\n > var bool = isComplex128( new Complex128( 3.0, 1.0 ) )\n true\n > bool = isComplex128( new Complex64( 2.0, 2.0 ) )\n false\n > bool = isComplex128( 3.14 )\n false\n > bool = isComplex128( {} )\n false\n\n See Also\n --------\n isComplex, isComplex64\n"
isComplex128Array,"\nisComplex128Array( value )\n Tests if a value is a Complex128Array.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a Complex128Array.\n\n Examples\n --------\n > var bool = isComplex128Array( new Complex128Array( 10 ) )\n true\n > bool = isComplex128Array( [] )\n false\n\n See Also\n --------\n isComplex, isComplex128, isComplex64Array, isComplexTypedArray\n"
isComplex128MatrixLike,"\nisComplex128MatrixLike( value )\n Tests if a value is a 2-dimensional ndarray-like object containing double-\n precision complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 2-dimensional ndarray-like\n object containing double-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex128';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex128MatrixLike( M )\n true\n > bool = isComplex128MatrixLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex128MatrixLike( 3.14 )\n false\n > bool = isComplex128MatrixLike( {} )\n false\n\n See Also\n --------\n isndarrayLike, isMatrixLike\n"
isComplex128ndarrayLike,"\nisComplex128ndarrayLike( value )\n Tests if a value is an ndarray-like object containing double-precision\n complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is an ndarray-like object containing\n double-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 2;\n > M.shape = [ 2, 2 ];\n > M.strides = [ 2, 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex128';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex128ndarrayLike( M )\n true\n > bool = isComplex128ndarrayLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex128ndarrayLike( 3.14 )\n false\n > bool = isComplex128ndarrayLike( {} )\n false\n\n See Also\n --------\n isndarrayLike\n"
isComplex128VectorLike,"\nisComplex128VectorLike( value )\n Tests if a value is a 1-dimensional ndarray-like object containing double-\n precision complex floating-point numbers.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a 1-dimensional ndarray-like\n object containing double-precision complex floating-point numbers.\n\n Examples\n --------\n > var M = {};\n > M.data = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );\n > M.ndims = 1;\n > M.shape = [ 4 ];\n > M.strides = [ 1 ];\n > M.offset = 0;\n > M.order = 'row-major';\n > M.dtype = 'complex128';\n > M.length = 4;\n > M.flags = {};\n > M.get = function get( i, j ) {};\n > M.set = function set( i, j ) {};\n > var bool = isComplex128VectorLike( M )\n true\n > bool = isComplex128VectorLike( [ 1, 2, 3, 4 ] )\n false\n > bool = isComplex128VectorLike( 3.14 )\n false\n > bool = isComplex128VectorLike( {} )\n false\n\n See Also\n --------\n isndarrayLike, isVectorLike\n"
isComplexLike,"\nisComplexLike( value )\n Tests if a value is a complex number-like object.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a complex number-like object.\n\n Examples\n --------\n > var bool = isComplexLike( new Complex64( 2.0, 2.0 ) )\n true\n > bool = isComplexLike( new Complex128( 3.0, 1.0 ) )\n true\n > bool = isComplexLike( 3.14 )\n false\n > bool = isComplexLike( {} )\n false\n\n See Also\n --------\n isComplex, isComplex64, isComplex128\n"
isComplexTypedArray,"\nisComplexTypedArray( value )\n Tests if a value is a complex typed array.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a complex typed array.\n\n Examples\n --------\n > var bool = isComplexTypedArray( new Complex64Array( 10 ) )\n true\n\n See Also\n --------\n isComplex, isComplex64Array, isComplex128Array\n"
isComplexTypedArrayLike,"\nisComplexTypedArrayLike( value )\n Tests if a value is complex-typed-array-like.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is complex-typed-array-like.\n\n Examples\n --------\n > var bool = isComplexTypedArrayLike( new Complex128Array() )\n true\n > bool = isComplexTypedArrayLike({\n ... 'length': 10,\n ... 'byteOffset': 0,\n ... 'byteLength': 10,\n ... 'BYTES_PER_ELEMENT': 4,\n ... 'get': function get() {},\n ... 'set': function set() {}\n ... })\n true\n\n See Also\n --------\n isComplexLike, isComplexTypedArray, isComplex64Array, isComplex128Array\n"
Expand Down
2 changes: 1 addition & 1 deletion help/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3696,6 +3696,7 @@ ndarrayPromotionRules,"\nndarrayPromotionRules( [dtype1:any, dtype2:any] )\n
ndarraySafeCasts,"\nndarraySafeCasts( [dtype:any] )\n Returns a list of ndarray data types to which a provided ndarray data type\n can be safely cast.\n"
ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype:any] )\n Returns a list of ndarray data types to which a provided ndarray data type\n can be safely cast or cast within the same \"kind\".\n"
ndarrayShape,"\nndarrayShape( x:ndarray )\n Returns the shape of a provided ndarray.\n"
ndarrayStride,"\nndarrayStride( x:ndarray, dim:integer )\n Returns the stride along a specified dimension for a provided ndarray.\n"
ndarrayStrides,"\nndarrayStrides( x:ndarray )\n Returns the strides of a provided ndarray.\n"
ndempty,"\nndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )\n Returns an uninitialized ndarray having a specified shape and data type.\n"
ndemptyLike,"\nndemptyLike( x:ndarray[, options:Object] )\n Returns an uninitialized ndarray having the same shape and data type as a\n provided input ndarray.\n"
Expand Down
2 changes: 1 addition & 1 deletion info/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3733,6 +3733,7 @@ ndarrayPromotionRules,"ndarrayPromotionRules( [dtype1, dtype2] )"
ndarraySafeCasts,"ndarraySafeCasts( [dtype] )"
ndarraySameKindCasts,"ndarraySameKindCasts( [dtype] )"
ndarrayShape,"ndarrayShape( x )"
ndarrayStride,"ndarrayStride( x, dim )"
ndarrayStrides,"ndarrayStrides( x )"
ndempty,"ndempty( shape[, options] )"
ndemptyLike,"ndemptyLike( x[, options] )"
Expand Down
2 changes: 1 addition & 1 deletion signature/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions typed-signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3733,6 +3733,7 @@ ndarrayPromotionRules,"ndarrayPromotionRules( [dtype1:any, dtype2:any] )"
ndarraySafeCasts,"ndarraySafeCasts( [dtype:any] )"
ndarraySameKindCasts,"ndarraySameKindCasts( [dtype:any] )"
ndarrayShape,"ndarrayShape( x:ndarray )"
ndarrayStride,"ndarrayStride( x:ndarray, dim:integer )"
ndarrayStrides,"ndarrayStrides( x:ndarray )"
ndempty,"ndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )"
ndemptyLike,"ndemptyLike( x:ndarray[, options:Object] )"
Expand Down
2 changes: 1 addition & 1 deletion typed-signature/data/data.json

Large diffs are not rendered by default.

0 comments on commit 61b7ad6

Please sign in to comment.