Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable max-len */
'use strict';
// MODULES //
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isIterableLike = require( '@stdlib/assert/is-iterable-like' );
var isCollection = require( '@stdlib/assert/is-collection' );
var isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isBuffer = require( '@stdlib/assert/is-buffer' );
var isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var buffer = require( '@stdlib/ndarray/base/buffer' );
var typedarray = require( '@stdlib/array/typed' );
var copy = require( '@stdlib/array/base/copy' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var defaults = require( '@stdlib/ndarray/defaults' );
var strides2offset = require( '@stdlib/ndarray/base/strides2offset' );
var arraybuffer2buffer = require( '@stdlib/buffer/from-arraybuffer' );
var array2buffer = require( '@stdlib/buffer/from-array' );
var copyBuffer = require( '@stdlib/buffer/from-buffer' );
var iterator2array = require( '@stdlib/array/from-iterator' );
var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
var ITERATOR_SYMBOL = require( '@stdlib/symbol/iterator' );
var format = require( '@stdlib/string/format' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
var DEFAULT_ORDER = defaults.get( 'order' );
// FUNCTIONS //
/**
* Tests whether a data type is a "generic" data type.
*
* @private
* @param {string} dtype - data type
* @returns {boolean} result
*/
function isGenericDataType( dtype ) {
return ( dtype === 'generic' );
}
/**
* Tests whether a data type is a binary data type.
*
* @private
* @param {string} dtype - data type
* @returns {boolean} result
*/
function isBinaryDataType( dtype ) {
return ( dtype === 'binary' );
}
/**
* Resolves the order of the output vector.
*
* @private
* @param {*} options - options argument
* @returns {string} order
*/
function resolveOrder( options ) {
if ( hasOwnProp( options, 'order' ) ) {
return options.order;
}
return DEFAULT_ORDER;
}
/**
* Creates a one-dimensional ndarray from an ArrayBuffer.
*
* @private
* @param {string} dtype - data type
* @param {ArrayBuffer} buffer - ArrayBuffer
* @param {NonNegativeInteger} length - number of indexed elements
* @param {integer} stride - stride length (in units of elements)
* @param {NonNegativeInteger} byteOffset - byte offset of the first indexed element
* @param {string} order - memory layout (either row-major or column-major)
* @param {Options} [options] - function options
* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only ndarray
* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed ndarray dimensions
* @throws {TypeError} data type must be compatible with the provided ArrayBuffer
* @returns {ndarray} one-dimensional ndarray
*
* @example
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var v = arraybuffer2vector( 'float64', buf, 4, 1, 0, 'row-major' );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 4
*
* @example
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var v = arraybuffer2vector( 'float32', buf, 8, 1, 0, 'row-major' );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 8
*
* @example
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var v = arraybuffer2vector( 'float64', buf, 4, -1, 32, 'row-major' );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 4
*
* @example
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var v = arraybuffer2vector( 'float64', buf, 2, -1, 24, 'row-major' );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 2
*/
function arraybuffer2vector( dtype, buffer, length, stride, byteOffset, order, options ) { // TODO: consider moving to `@stdlib/ndarray/from-arraybuffer` and generalize to n-dimensions such that `length` becomes `shape` and `stride` becomes `strides`
var buf;
var sh;
var st;
var N;
var o;
if ( isGenericDataType( dtype ) ) {
throw new TypeError( format( 'invalid argument. ArrayBuffer is incompatible with the specified data type. Value: `%s`.', dtype ) );
}
o = byteOffset;
// Compute the number of underlying elements across which the vector view will span:
N = length * stride;
// Adjust the byte offset to point to the element marking the beginning of the view:
if ( stride < 0 ) { // TODO: the following is effectively unreachable code, as provided strides are never anything other than unity; however, we keep this around in the event that we want to extract this function to a separate package and would like to maintain generality
N *= -1;
o -= N * bytesPerElement( dtype );
}
// Create the underlying ndarray buffer:
if ( isBinaryDataType( dtype ) ) {
buf = arraybuffer2buffer( buffer, o, N );
} else {
buf = typedarray( buffer, o, N, dtype );
}
// Resolve ndarray meta data:
sh = [ length ];
st = [ stride ];
o = strides2offset( sh, st );
// Return a new ndarray instance:
if ( arguments.length > 6 ) {
return new ndarray( dtype, buf, sh, st, o, order, options );
}
return new ndarray( dtype, buf, sh, st, o, order );
}
/**
* Returns a vector having a specified data type.
*
* @private
* @param {(NonNegativeInteger|Collection|ArrayBuffer|Buffer|Iterable|Options)} arg - length, typed array, array-like object, buffer, iterable, or options object
* @param {string} dtype - data type
* @param {(Options|null)} options - function options
* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only ndarray
* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed ndarray dimensions
* @returns {(ndarray|null)} one-dimensional ndarray
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var v = vectorWithDType( 10, 'float64', {} );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 10
*
* var dt = getDType( v );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var v = vectorWithDType( [ 1, 2, 3, 4 ], 'generic', {} );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 4
*
* var dt = getDType( v );
* // returns 'generic'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var v = vectorWithDType( buf, 'float64', {} );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 4
*
* var dt = getDType( v );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var v = vectorWithDType( {}, 'float64', null );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 0
*
* var dt = getDType( v );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
* var array2iterator = require( '@stdlib/array/to-iterator' );
*
* var v = vectorWithDType( array2iterator( [ 1, 2, 3, 4 ] ), 'generic', {} );
* // returns <ndarray>
*
* var len = numel( v );
* // returns 4
*
* var dt = getDType( v );
* // returns 'generic'
*/
function vectorWithDType( arg, dtype, options ) {
var opts;
var buf;
// Note: in all of the following, we delegate option validation to the ndarray constructor...
if ( options === null ) {
opts = {};
} else {
opts = options;
}
// Case: vector( length )
if ( isNonNegativeInteger( arg ) ) {
buf = buffer( dtype, arg );
return new ndarray( dtype, buf, [ buf.length ], [ 1 ], 0, resolveOrder( opts ), opts );
}
// Case: vector( Buffer )
if ( isBuffer( arg ) ) {
if ( isGenericDataType( dtype ) ) {
buf = copy( arg );
} else if ( isBinaryDataType( dtype ) ) {
buf = copyBuffer( arg );
} else {
buf = typedarray( arg, dtype );
}
return new ndarray( dtype, buf, [ buf.length ], [ 1 ], 0, resolveOrder( opts ), opts );
}
// Case: vector( collection )
if ( isCollection( arg ) ) {
if ( isGenericDataType( dtype ) ) {
buf = copy( arg );
} else if ( isBinaryDataType( dtype ) ) {
buf = array2buffer( arg ); // note: we assume that `arg` is an array of octets
} else {
buf = typedarray( arg, dtype );
}
return new ndarray( dtype, buf, [ buf.length ], [ 1 ], 0, resolveOrder( opts ), opts );
}
// Case: vector( ArrayBuffer )
if ( isArrayBuffer( arg ) ) {
return arraybuffer2vector( dtype, arg, arg.byteLength/bytesPerElement( dtype ), 1, 0, resolveOrder( opts ), opts );
}
// Case: vector( Iterable )
if ( isIterableLike( arg ) ) {
buf = arg[ ITERATOR_SYMBOL ]();
buf = iterator2array( buf );
if ( isBinaryDataType( dtype ) ) {
buf = array2buffer( buf );
} else if ( !isGenericDataType( dtype ) ) {
buf = typedarray( buf, dtype );
}
return new ndarray( dtype, buf, [ buf.length ], [ 1 ], 0, resolveOrder( opts ), opts );
}
// Case: vector( options )
if ( options === null && isPlainObject( arg ) ) {
buf = buffer( dtype, 0 );
return new ndarray( dtype, buf, [ buf.length ], [ 1 ], 0, resolveOrder( arg ), arg );
}
return null;
}
// MAIN //
/**
* Creates a vector (i.e., a one-dimensional ndarray).
*
* ## Notes
*
* - This API is intended to match the conventions of `@stdlib/array/typed`, which has a similar signature.
*
* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable
* @param {NonNegativeInteger} [byteOffset=0] - byte offset
* @param {NonNegativeInteger} [length] - view length
* @param {string} [dtype='float64'] - data type
* @param {Options} [options] - function options
* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector
* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions
* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)
* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, data type, or options object
* @throws {TypeError} must provide valid options
* @returns {ndarray} one-dimensional ndarray
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var arr = vector();
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 0
*
* var dt = getDType( arr );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var arr = vector( 2 );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 2
*
* var dt = getDType( arr );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var arr = vector( [ 1.0, 2.0 ] );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 2
*
* var dt = getDType( arr );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
*
* var arr = vector( [ 1.0, 2.0 ], 'float32' );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 2
*
* var dt = getDType( arr );
* // returns 'float32'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = vector( buf );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 4
*
* var dt = getDType( arr );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = vector( buf, 16 );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 2
*
* var dt = getDType( arr );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var numel = require( '@stdlib/ndarray/numel' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 64 );
* var arr = vector( buf, 16, 2 );
* // returns <ndarray>
*
* var len = numel( arr );
* // returns 2
*
* var dt = getDType( arr );
* // returns 'float64'
*/
function vector() {
var nargs;
var arg0;
var arg1;
var arg2;
var arg3;
var arg4;
var buf;
var out;
nargs = arguments.length;
// Case: vector()
if ( nargs === 0 ) {
buf = buffer( DEFAULT_DTYPE, 0 );
return new ndarray( DEFAULT_DTYPE, buf, [ buf.length ], [ 1 ], 0, DEFAULT_ORDER );
}
arg0 = arguments[ 0 ];
// Case: vector( arg0 );
if ( nargs === 1 ) {
if ( isDataType( arg0 ) ) {
return vectorWithDType( 0, arg0, null );
}
out = vectorWithDType( arg0, DEFAULT_DTYPE, null );
if ( out === null ) {
throw new TypeError( format( 'invalid argument. Must provide a length, ArrayBuffer, typed array, array-like object, iterable, data type, or options object. Value: `%s`.', arg0 ) );
}
return out;
}
arg1 = arguments[ 1 ];
// Case: vector( arg0, arg1 )
if ( nargs === 2 ) {
// Case: vector( dtype, options )
if ( isDataType( arg0 ) ) {
if ( arg1 === null ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg1 ) );
}
return vectorWithDType( 0, arg0, arg1 );
}
// Case: vector( arg0, dtype )
if ( isDataType( arg1 ) ) {
out = vectorWithDType( arg0, arg1, null );
if ( out === null ) {
throw new TypeError( format( 'invalid argument. First argument must be a length, ArrayBuffer, typed array, array-like object, or iterable. Value: `%s`.', arg0 ) );
}
return out;
}
// Case: vector( ArrayBuffer, byteOffset )
if ( isNonNegativeInteger( arg1 ) ) {
if ( !isArrayBuffer( arg0 ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', arg0 ) );
}
return arraybuffer2vector( DEFAULT_DTYPE, arg0, (arg0.byteLength-arg1)/bytesPerElement( DEFAULT_DTYPE ), 1, arg1, DEFAULT_ORDER );
}
// Case: vector( arg0, options )
if ( arg1 === null ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg1 ) );
}
out = vectorWithDType( arg0, DEFAULT_DTYPE, arg1 );
if ( out === null ) {
throw new TypeError( format( 'invalid argument. First argument must be a length, ArrayBuffer, typed array, array-like object, or iterable. Value: `%s`.', arg0 ) );
}
return out;
}
arg2 = arguments[ 2 ];
// Case: vector( arg0, arg1, arg2 )
if ( nargs === 3 ) {
// Case: vector( ArrayBuffer, byteOffset, dtype )
if ( isDataType( arg2 ) ) {
if ( !isArrayBuffer( arg0 ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', arg0 ) );
}
if ( !isNonNegativeInteger( arg1 ) ) {
throw new TypeError( format( 'invalid argument. Byte offset must be a nonnegative integer. Value: `%s`.', arg1 ) );
}
return arraybuffer2vector( arg2, arg0, (arg0.byteLength-arg1)/bytesPerElement( arg2 ), 1, arg1, DEFAULT_ORDER );
}
// Case: vector( arg0, dtype, options )
if ( isDataType( arg1 ) ) {
if ( arg2 === null ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg2 ) );
}
out = vectorWithDType( arg0, arg1, arg2 );
if ( out === null ) {
throw new TypeError( format( 'invalid argument. First argument must be a length, ArrayBuffer, typed array, array-like object, or iterable. Value: `%s`.', arg0 ) );
}
return out;
}
// Case: vector( ArrayBuffer, byteOffset, arg2 )
if ( !isArrayBuffer( arg0 ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', arg0 ) );
}
if ( !isNonNegativeInteger( arg1 ) ) {
throw new TypeError( format( 'invalid argument. Byte offset must be a nonnegative integer. Value: `%s`.', arg1 ) );
}
// Case: vector( ArrayBuffer, byteOffset, length )
if ( isNonNegativeInteger( arg2 ) ) {
return arraybuffer2vector( DEFAULT_DTYPE, arg0, arg2, 1, arg1, DEFAULT_ORDER );
}
// Case: vector( ArrayBuffer, byteOffset, options )
if ( arg2 === null ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg2 ) );
}
return arraybuffer2vector( DEFAULT_DTYPE, arg0, (arg0.byteLength-arg1)/bytesPerElement( DEFAULT_DTYPE ), 1, arg1, resolveOrder( arg2 ), arg2 );
}
arg3 = arguments[ 3 ];
// Case: vector( ArrayBuffer, byteOffset, arg2, arg3 )
if ( nargs === 4 ) {
if ( !isArrayBuffer( arg0 ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', arg0 ) );
}
if ( !isNonNegativeInteger( arg1 ) ) {
throw new TypeError( format( 'invalid argument. Byte offset must be a nonnegative integer. Value: `%s`.', arg1 ) );
}
// Case: vector( ArrayBuffer, byteOffset, length, dtype )
if ( isNonNegativeInteger( arg2 ) ) {
if ( isDataType( arg3 ) ) {
return arraybuffer2vector( arg3, arg0, arg2, 1, arg1, DEFAULT_ORDER );
}
// Case: vector( ArrayBuffer, byteOffset, length, options )
if ( !isPlainObject( arg3 ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg3 ) );
}
return arraybuffer2vector( DEFAULT_DTYPE, arg0, arg2, 1, arg1, resolveOrder( arg3 ), arg3 );
}
// Case: vector( ArrayBuffer, byteOffset, dtype, options )
if ( !isDataType( arg2 ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a recognized/supported data type. Value: `%s`.', arg2 ) );
}
if ( !isPlainObject( arg3 ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg3 ) );
}
return arraybuffer2vector( arg2, arg0, (arg0.byteLength-arg1)/bytesPerElement( arg2 ), 1, arg1, resolveOrder( arg3 ), arg3 );
}
arg4 = arguments[ 4 ];
// Case: vector( ArrayBuffer, byteOffset, length, dtype, options )
if ( !isArrayBuffer( arg0 ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', arg0 ) );
}
if ( !isNonNegativeInteger( arg1 ) ) {
throw new TypeError( format( 'invalid argument. Byte offset must be a nonnegative integer. Value: `%s`.', arg1 ) );
}
if ( !isNonNegativeInteger( arg2 ) ) {
throw new TypeError( format( 'invalid argument. Length must be a nonnegative integer. Value: `%s`.', arg2 ) );
}
if ( !isDataType( arg3 ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must be a recognized/supported data type. Value: `%s`.', arg3 ) );
}
if ( !isPlainObject( arg4 ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', arg4 ) );
}
return arraybuffer2vector( arg3, arg0, arg2, 1, arg1, resolveOrder( arg4 ), arg4 );
}
// EXPORTS //
module.exports = vector;
|