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 | 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 37x 37x 16x 16x 37x 5x 5x 37x 5x 5x 37x 7x 7x 7x 37x 19x 19x 19x 3x 3x 19x 4x 4x 19x 37x 2x 2x 2x 14x 37x 3x 3x 3x 3x 3x | /**
* @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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isCollection = require( '@stdlib/assert/is-collection' );
var isIntegerArray = require( '@stdlib/assert/is-integer-array' ).primitives;
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var normalizeIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Validates function options.
*
* @private
* @param {Object} opts - destination object
* @param {NonNegativeInteger} ndims - number of input ndarray dimensions
* @param {Options} options - function options
* @param {string} [options.prefix] - prefix to prepend to each joined string
* @param {string} [options.suffix] - suffix to append to each joined string
* @param {ArrayLikeObject} [options.separators] - separators
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @param {boolean} [options.keepdims] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
* @returns {(Error|null)} null or an error object
*
* @example
* var opts = {
* 'prefix': '',
* 'suffix': '',
* 'separators': [ ',' ],
* 'dims': [ 0, 1 ],
* 'keepdims': false
* };
* var options = {
* 'separators': [ ' + ', ' = ' ],
* 'dims': [ -1 ]
* };
* var err = validate( opts, 2, options );
* if ( err ) {
* throw err;
* }
*/
function validate( opts, ndims, options ) {
if ( !isPlainObject( options ) ) {
return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'prefix' ) ) {
opts.prefix = options.prefix;
}
if ( hasOwnProp( options, 'suffix' ) ) {
opts.suffix = options.suffix;
}
if ( hasOwnProp( options, 'separators' ) ) {
opts.separators = options.separators;
if ( !isCollection( opts.separators ) ) {
return new TypeError( format( 'invalid option. `%s` option must be an array-like object. Option: `%s`.', 'separators', opts.separators ) );
}
}
if ( hasOwnProp( options, 'dims' ) ) {
if ( !isIntegerArray( options.dims ) ) {
return new TypeError( format( 'invalid option. `%s` option must be an array of integers. Option: `%s`.', 'dims', options.dims ) );
}
opts.dims = normalizeIndices( options.dims, ndims-1 );
if ( opts.dims === null ) {
return new RangeError( format( 'invalid option. `%s` option contains an out-of-bounds dimension index.', 'dims' ) );
}
if ( opts.dims.length !== options.dims.length ) {
return new Error( format( 'invalid option. `%s` option contains duplicate indices.', 'dims' ) );
}
}
if ( hasOwnProp( options, 'keepdims' ) ) {
opts.keepdims = options.keepdims;
if ( !isBoolean( opts.keepdims ) ) {
return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'keepdims', opts.keepdims ) );
}
}
return null;
}
// EXPORTS //
module.exports = validate;
|