Skip to content

Commit 4bdd095

Browse files
committed
feat: add booleanndarray and boolndarray type definitions
1 parent d71c3a9 commit 4bdd095

File tree

1 file changed

+115
-1
lines changed

1 file changed

+115
-1
lines changed

lib/node_modules/@stdlib/types/index.d.ts

Lines changed: 115 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,7 +1384,7 @@ declare module '@stdlib/types/blas' {
13841384
* };
13851385
*/
13861386
declare module '@stdlib/types/ndarray' {
1387-
import { ArrayLike, AccessorArrayLike, Collection, Complex128Array, Complex64Array, RealOrComplexTypedArray, FloatOrComplexTypedArray, RealTypedArray, ComplexTypedArray, IntegerTypedArray, FloatTypedArray, SignedIntegerTypedArray, UnsignedIntegerTypedArray } from '@stdlib/types/array';
1387+
import { ArrayLike, AccessorArrayLike, BooleanArray, BooleanTypedArray, Collection, Complex128Array, Complex64Array, RealOrComplexTypedArray, FloatOrComplexTypedArray, RealTypedArray, ComplexTypedArray, IntegerTypedArray, FloatTypedArray, SignedIntegerTypedArray, UnsignedIntegerTypedArray } from '@stdlib/types/array';
13881388
import { ComplexLike, Complex128, Complex64 } from '@stdlib/types/complex'; // eslint-disable-line no-duplicate-imports
13891389
import { Layout } from '@stdlib/types/blas';
13901390

@@ -2779,6 +2779,120 @@ declare module '@stdlib/types/ndarray' {
27792779
set( ...args: Array<number> ): uint8cndarray;
27802780
}
27812781

2782+
/**
2783+
* Interface describing an ndarray having a boolean data type.
2784+
*
2785+
* @example
2786+
* const arr: booleanndarray = {
2787+
* 'byteLength': 3,
2788+
* 'BYTES_PER_ELEMENT': 1,
2789+
* 'data': new BooleanArray( [ true, false, true ] ),
2790+
* 'dtype': 'bool',
2791+
* 'flags': {
2792+
* 'ROW_MAJOR_CONTIGUOUS': true,
2793+
* 'COLUMN_MAJOR_CONTIGUOUS': false
2794+
* },
2795+
* 'length': 3,
2796+
* 'ndims': 1,
2797+
* 'offset': 0,
2798+
* 'order': 'row-major',
2799+
* 'shape': [ 3 ],
2800+
* 'strides': [ 1 ],
2801+
* 'get': function get( i ) {
2802+
* return this.data.get( i );
2803+
* },
2804+
* 'set': function set( i, v ) {
2805+
* this.data.set( v, i );
2806+
* return this;
2807+
* }
2808+
* };
2809+
*/
2810+
interface booleanndarray extends typedndarray<boolean> {
2811+
/**
2812+
* Size (in bytes) of each array element.
2813+
*/
2814+
BYTES_PER_ELEMENT: 1;
2815+
2816+
/**
2817+
* A reference to the underlying data buffer.
2818+
*/
2819+
data: BooleanTypedArray;
2820+
2821+
/**
2822+
* Underlying data type.
2823+
*/
2824+
dtype: 'bool';
2825+
2826+
/**
2827+
* Sets an array element specified according to provided subscripts.
2828+
*
2829+
* ## Notes
2830+
*
2831+
* - The number of provided subscripts should equal the number of dimensions.
2832+
*
2833+
* @param args - subscripts and value to set
2834+
* @returns ndarray instance
2835+
*/
2836+
set( ...args: Array<number | boolean> ): booleanndarray;
2837+
}
2838+
2839+
/**
2840+
* Interface describing an ndarray having a boolean data type.
2841+
*
2842+
* @example
2843+
* const arr: boolndarray = {
2844+
* 'byteLength': 3,
2845+
* 'BYTES_PER_ELEMENT': 1,
2846+
* 'data': new BooleanArray( [ true, false, true ] ),
2847+
* 'dtype': 'bool',
2848+
* 'flags': {
2849+
* 'ROW_MAJOR_CONTIGUOUS': true,
2850+
* 'COLUMN_MAJOR_CONTIGUOUS': false
2851+
* },
2852+
* 'length': 3,
2853+
* 'ndims': 1,
2854+
* 'offset': 0,
2855+
* 'order': 'row-major',
2856+
* 'shape': [ 3 ],
2857+
* 'strides': [ 1 ],
2858+
* 'get': function get( i ) {
2859+
* return this.data.get( i );
2860+
* },
2861+
* 'set': function set( i, v ) {
2862+
* this.data.set( v, i );
2863+
* return this;
2864+
* }
2865+
* };
2866+
*/
2867+
interface boolndarray extends booleanndarray {
2868+
/**
2869+
* Size (in bytes) of each array element.
2870+
*/
2871+
BYTES_PER_ELEMENT: 1;
2872+
2873+
/**
2874+
* A reference to the underlying data buffer.
2875+
*/
2876+
data: BooleanArray;
2877+
2878+
/**
2879+
* Underlying data type.
2880+
*/
2881+
dtype: 'bool';
2882+
2883+
/**
2884+
* Sets an array element specified according to provided subscripts.
2885+
*
2886+
* ## Notes
2887+
*
2888+
* - The number of provided subscripts should equal the number of dimensions.
2889+
*
2890+
* @param args - subscripts and value to set
2891+
* @returns ndarray instance
2892+
*/
2893+
set( ...args: Array<number | boolean> ): boolndarray;
2894+
}
2895+
27822896
/**
27832897
* Interface describing an ndarray having a real-valued data type.
27842898
*

0 commit comments

Comments
 (0)