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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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) 2026 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.
*/
'use strict';
// MODULES //
var isObject = require( '@stdlib/assert/is-plain-object' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isIndexMode = require( '@stdlib/ndarray/base/assert/is-index-mode' );
var isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Validates function options.
*
* @private
* @param {Object} opts - destination object
* @param {Options} options - function options
* @param {boolean} [options.readonly] - boolean indicating whether to return a read-only matrix
* @param {string} [options.mode] - specifies how to handle indices which exceed matrix dimensions
* @param {StringArray} [options.submode] - specifies how to handle subscripts which exceed array dimensions
* @param {string} [options.order] - memory layout (either row-major or column-major)
* @returns {(Error|null)} null or an error object
*
* @example
* var opts = {};
* var options = {
* 'readonly': true
* };
* var err = validate( opts, options );
* if ( err ) {
* throw err;
* }
*/
function validate( opts, options ) {
var tmp;
var i;
if ( !isObject( options ) ) {
return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'readonly' ) ) {
opts.readonly = options.readonly;
if ( !isBoolean( opts.readonly ) ) {
return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'readonly', opts.readonly ) );
}
}
if ( hasOwnProp( options, 'mode' ) ) {
opts.mode = options.mode;
if ( !isIndexMode( opts.mode ) ) {
return new TypeError( format( 'invalid option. `%s` option must be a valid index mode. Option: `%s`.', 'mode', opts.mode ) );
}
}
if ( hasOwnProp( options, 'submode' ) ) {
if ( !isArrayLikeObject( options.submode ) ) {
return new TypeError( format( 'invalid option. `%s` option must be an array containing recognized modes. Option: `%s`.', 'submode', options.submode ) );
}
if ( options.submode.length === 0 ) {
return new TypeError( format( 'invalid option. `%s` option must be an array containing recognized modes. Option: `%s`.', 'submode', join( options.submode, ',' ) ) );
}
tmp = [];
for ( i = 0; i < options.submode.length; i++ ) {
if ( !isIndexMode( options.submode[ i ] ) ) {
return new TypeError( format( 'invalid option. Each submode must be a recognized mode. Option: `%s`.', options.submode[ i ] ) );
}
tmp.push( options.submode[ i ] );
}
opts.submode = tmp;
}
if ( hasOwnProp( options, 'order' ) ) {
opts.order = options.order;
if ( !isOrder( opts.order ) ) {
return new TypeError( format( 'invalid option. `%s` option must be a memory layout. Option: `%s`.', 'order', opts.order ) );
}
}
return null;
}
// EXPORTS //
module.exports = validate;
|