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 | 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 469x 469x 469x 469x 469x 469x 469x 469x 12x 6x 6x 6x 6x 469x 60x 60x 397x 397x 429x 176x 176x 33x 33x 176x 364x 364x 364x 364x 364x 364x 364x 469x 266x 252x 252x 252x 252x 26x 252x 208x 226x 18x 18x 266x 14x 14x 14x 469x 40x 86x 26x 58x 26x 28x 6x 6x 469x 18x 18x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 322x 469x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 138x 138x 138x 138x 138x 138x 15x 15x 123x 123x 123x 123x 123x 123x 123x 123x 123x 123x 123x 123x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 389x 389x 389x 389x 389x 389x 389x 18x 18x 371x 371x 371x 371x 371x 371x 371x 371x 371x 371x 371x 389x 62x 62x 371x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 21x 7x 7x 14x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 14x 7x 7x 7x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 646x 7x 7x 639x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 410x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 22x 7x 7x 15x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 22x 7x 7x 15x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 2x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 13x 1x 1x 12x 12x 12x 12x 12x 4x 4x 4x 4x 4x 4x | /**
* @license Apache-2.0
*
* Copyright (c) 2024 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 no-restricted-syntax, no-invalid-this */
'use strict';
// MODULES //
var setReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' );
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var setNonEnumerable = require( '@stdlib/utils/define-nonenumerable-property' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
var dtype = require( '@stdlib/ndarray/base/dtype' );
var ndarray2json = require( '@stdlib/ndarray/to-json' );
var format = require( '@stdlib/string/format' );
var defaults = require( './defaults.js' );
var validate = require( './validate.js' );
var cache = require( './cache.js' );
var findndindex = require( './find.js' );
var generateId = require( './id.js' );
// MAIN //
/**
* ndarray index constructor.
*
* @constructor
* @param {ndarray} x - input ndarray
* @param {Options} [options] - function options
* @param {boolean} [options.persist=false] - boolean indicating whether to continue persisting an index object after first usage
* @param {string} [options.kind=''] - specifies whether a provided ndarray is a specialized kind of integer input ndarray
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} first argument must be a valid index ndarray
* @throws {TypeError} first argument must be compatible with a specified index "kind"
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {ndindex} ndindex instance
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*/
function ndindex( x ) {
var opts;
var err;
var arr;
var dt;
var t;
var v;
if ( !(this instanceof ndindex) ) {
if ( arguments.length > 1 ) {
return new ndindex( x, arguments[ 1 ] );
}
return new ndindex( x );
}
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
}
// Resolve index options:
opts = defaults();
if ( arguments.length > 1 ) {
err = validate( opts, arguments[ 1 ] );
if ( err ) {
throw err;
}
}
// Normalize the input ndarray-like object by converting to a "base" ndarray:
arr = ndarraylike2ndarray( x );
// Resolve the input ndarray data type:
dt = dtype( arr ); // note: as we've normalized to a "base" ndarray, there should always be a resolved data type
// When provided a "generic" ndarray, attempt to infer the type of index ndarray...
if ( dt === 'generic' ) {
if ( arr.length > 0 ) {
v = arr.iget( 0 ); // note: we assume that, even for zero-dimensional ndarrays, we can pass `0` as an argument to `#.iget`
// Infer the "type" of index array from the first element...
if ( isBoolean( v ) ) {
t = 'bool';
} else if ( isInteger( v ) ) {
t = 'int';
} else {
throw new TypeError( 'invalid argument. First argument must be a valid index ndarray.' );
}
} else {
// If we've been provided an empty ndarray, fallback to a default index type:
t = 'int';
}
} else if ( dt === 'int64' || dt === 'int32' ) {
t = 'int';
} else if ( dt === 'uint8' ) {
t = 'mask';
} else if ( dt === 'bool' ) {
t = 'bool';
} else {
throw new TypeError( 'invalid argument. First argument must be a valid index ndarray.' );
}
if ( t !== 'int' && opts.kind !== '' ) { // note: here we assume that only integer ndarrays can have specialized "kinds"
throw new TypeError( format( 'invalid argument. First argument is not compatible with the specified index "kind". Type: %s. Kind: %s.', t, opts.kind ) );
}
// Add the ndarray index to the index cache:
cache.push({
'id': generateId(),
'ref': this,
'data': arr, // note: while we cache a reference to the normalized ndarray object, and not the original input ndarray-like object, we still hold onto memory, as the normalized object references the same underlying data buffer
'type': t,
'kind': opts.kind,
'dtype': dt,
'persist': opts.persist
});
// Store a reference to the cache node:
setReadOnly( this, '_node', cache.last() );
// Initialize a boolean flag indicating whether an index object has been invalidated (i.e., freed):
setNonEnumerable( this, '_invalidated', false );
return this;
}
/**
* Constructor name.
*
* @name name
* @memberof ndindex
* @readonly
* @type {string}
* @default 'ndindex'
*
* @example
* var str = ndindex.name;
* // returns 'ndindex'
*/
setReadOnly( ndindex, 'name', 'ndindex' );
/**
* Frees an ndarray index object associated with a provided identifier.
*
* @name free
* @memberof ndindex
* @type {Function}
* @param {string} id - identifier
* @returns {boolean} boolean indicating whether an index object was successfully freed
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x, {
* 'persist': true
* });
* // returns <ndindex>
*
* // ...
*
* var out = ndindex.free( idx.id );
* // returns true
*/
setReadOnly( ndindex, 'free', function free( id ) {
var node;
var v;
// Retrieve the index object with the specified identifier:
node = findndindex( id );
if ( node === null ) {
return false;
}
v = node.value;
// Invalidate the index instance object:
setReadOnly( v.ref, '_invalidated', true );
// Remove the index instance from the cache:
cache.remove( node );
// Remove the reference to the cached ndarray:
v.data = null;
return true;
});
/**
* Returns the ndarray associated with a provided identifier.
*
* @name get
* @memberof ndindex
* @type {Function}
* @param {string} id - identifier
* @returns {(Object|null)} object containing index data
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x, {
* 'persist': true
* });
* // returns <ndindex>
*
* // ...
*
* var o = ndindex.get( idx.id );
* // returns {...}
*
* var d = o.data;
* // returns <ndarray>
*
* var t = o.type;
* // returns 'mask'
*
* var dt = o.dtype;
* // returns 'uint8'
*/
setReadOnly( ndindex, 'get', function get( id ) {
var node;
var out;
var v;
// Retrieve the index object with the specified identifier:
node = findndindex( id );
if ( node === null ) {
return null;
}
v = node.value;
// Assemble the output object:
out = {
'data': v.data,
'type': v.type,
'kind': v.kind,
'dtype': v.dtype
};
// If the index object should not be persisted, go ahead and remove the object from the cache...
if ( !v.persist ) {
ndindex.free( id ); // note: this should come last, after having retrieved all desired index node data
}
return out;
});
/**
* Returns the underlying data of an ndarray index object.
*
* @name data
* @memberof ndindex.prototype
* @readonly
* @type {ndarray}
* @throws {Error} index object is no longer valid
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var v = idx.data;
* // returns <ndarray>
*/
setReadOnlyAccessor( ndindex.prototype, 'data', function get() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return this._node.value.data;
});
/**
* Returns the underlying data type of an ndarray index object.
*
* @name dtype
* @memberof ndindex.prototype
* @readonly
* @type {string}
* @throws {Error} index object is no longer valid
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var t = idx.dtype;
* // returns 'uint8'
*/
setReadOnlyAccessor( ndindex.prototype, 'dtype', function get() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return this._node.value.dtype;
});
/**
* Returns the identifier associated with an ndarray index object.
*
* @name id
* @memberof ndindex.prototype
* @readonly
* @type {string}
* @throws {Error} index object is no longer valid
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var id = idx.id;
* // returns <string>
*/
setReadOnlyAccessor( ndindex.prototype, 'id', function get() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return this._node.value.id;
});
/**
* Returns a boolean indicating if an ndarray index object is actively cached.
*
* @name isCached
* @memberof ndindex.prototype
* @readonly
* @type {boolean}
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var out = idx.isCached;
* // returns true
*/
setReadOnlyAccessor( ndindex.prototype, 'isCached', function get() {
return !this._invalidated;
});
/**
* Returns the ndarray index object "kind".
*
* @name kind
* @memberof ndindex.prototype
* @readonly
* @type {string}
* @throws {Error} index object is no longer valid
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'int32'
* });
*
* var idx = new ndindex( x, {
* 'kind': 'linear'
* });
* // returns <ndindex>
*
* var v = idx.kind;
* // returns 'linear'
*/
setReadOnlyAccessor( ndindex.prototype, 'kind', function get() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return this._node.value.kind;
});
/**
* Returns the type of an ndarray index object.
*
* @name type
* @memberof ndindex.prototype
* @readonly
* @type {string}
* @throws {Error} index object is no longer valid
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var t = idx.type;
* // returns 'mask'
*/
setReadOnlyAccessor( ndindex.prototype, 'type', function get() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return this._node.value.type;
});
/**
* Serializes an ndarray index object to a string.
*
* @name toString
* @memberof ndindex.prototype
* @type {Function}
* @throws {Error} index object is no longer valid
* @returns {string} serialized index object
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var str = idx.toString();
* // e.g., 'ndindex<0>'
*/
setReadOnly( ndindex.prototype, 'toString', function toString() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return 'ndindex<' + this._node.value.id + '>';
});
/**
* Serializes an ndarray index object as a JSON object.
*
* ## Notes
*
* - `JSON.stringify()` implicitly calls this method when stringifying an `ndindex` instance.
*
* @name toJSON
* @memberof ndindex.prototype
* @type {Function}
* @throws {Error} index object is no longer valid
* @returns {Object} serialized index object
*
* @example
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 10 ], {
* 'dtype': 'uint8'
* });
*
* var idx = new ndindex( x );
* // returns <ndindex>
*
* var o = idx.toJSON();
* // returns { 'type': 'ndindex', 'kind': '', 'data': {...} }
*/
setReadOnly( ndindex.prototype, 'toJSON', function toJSON() {
if ( this._invalidated ) {
throw new Error( 'invalid operation. This ndarray index instance has already been freed and can no longer be used.' );
}
return {
'type': 'ndindex',
'kind': this._node.value.kind,
'data': ndarray2json( this._node.value.data )
};
});
// EXPORTS //
module.exports = ndindex;
|