|
21 | 21 | /* eslint-disable max-lines */
|
22 | 22 |
|
23 | 23 | import base = require( '@stdlib/array/base' );
|
| 24 | +import BooleanArray = require( '@stdlib/array/bool' ); |
24 | 25 | import ArrayBuffer = require( '@stdlib/array/buffer' );
|
25 | 26 | import cartesianPower = require( '@stdlib/array/cartesian-power' );
|
26 | 27 | import cartesianProduct = require( '@stdlib/array/cartesian-product' );
|
@@ -120,6 +121,70 @@ interface Namespace {
|
120 | 121 | */
|
121 | 122 | base: typeof base;
|
122 | 123 |
|
| 124 | + /** |
| 125 | + * Boolean array constructor. |
| 126 | + * |
| 127 | + * @param arg - length, typed array, array-like object, or buffer |
| 128 | + * @param byteOffset - byte offset (default: 0) |
| 129 | + * @param length - view length |
| 130 | + * @throws if provided only a single argument, must provide a valid argument |
| 131 | + * @throws byte offset must be a nonnegative integer |
| 132 | + * @throws must provide sufficient memory to accommodate byte offset and view length requirements |
| 133 | + * @returns boolean array |
| 134 | + * |
| 135 | + * @example |
| 136 | + * var arr = new ns.BooleanArray(); |
| 137 | + * // returns <ns.BooleanArray> |
| 138 | + * |
| 139 | + * var len = arr.length; |
| 140 | + * // returns 0 |
| 141 | + * |
| 142 | + * @example |
| 143 | + * var arr = new ns.BooleanArray( 2 ); |
| 144 | + * // returns <ns.BooleanArray> |
| 145 | + * |
| 146 | + * var len = arr.length; |
| 147 | + * // returns 2 |
| 148 | + * |
| 149 | + * @example |
| 150 | + * var arr = new ns.BooleanArray( [ true, false ] ); |
| 151 | + * // returns <ns.BooleanArray> |
| 152 | + * |
| 153 | + * var len = arr.length; |
| 154 | + * // returns 2 |
| 155 | + * |
| 156 | + * @example |
| 157 | + * var ArrayBuffer = require( '@stdlib/array/buffer' ); |
| 158 | + * |
| 159 | + * var buf = new ArrayBuffer( 16 ); |
| 160 | + * var arr = new ns.BooleanArray( buf ); |
| 161 | + * // returns <ns.BooleanArray> |
| 162 | + * |
| 163 | + * var len = arr.length; |
| 164 | + * // returns 16 |
| 165 | + * |
| 166 | + * @example |
| 167 | + * var ArrayBuffer = require( '@stdlib/array/buffer' ); |
| 168 | + * |
| 169 | + * var buf = new ArrayBuffer( 16 ); |
| 170 | + * var arr = new ns.BooleanArray( buf, 8 ); |
| 171 | + * // returns <ns.BooleanArray> |
| 172 | + * |
| 173 | + * var len = arr.length; |
| 174 | + * // returns 8 |
| 175 | + * |
| 176 | + * @example |
| 177 | + * var ArrayBuffer = require( '@stdlib/array/buffer' ); |
| 178 | + * |
| 179 | + * var buf = new ArrayBuffer( 32 ); |
| 180 | + * var arr = new ns.BooleanArray( buf, 8, 2 ); |
| 181 | + * // returns <ns.BooleanArray> |
| 182 | + * |
| 183 | + * var len = arr.length; |
| 184 | + * // returns 2 |
| 185 | + */ |
| 186 | + BooleanArray: typeof BooleanArray; |
| 187 | + |
123 | 188 | /**
|
124 | 189 | * Constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
|
125 | 190 | */
|
|
0 commit comments