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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 94x 94x 94x 94x 94x 94x 94x 94x 20x 20x 74x 94x 60x 60x 8x 8x 52x 60x 24x 13x 13x 11x 60x 28x 28x 60x 21x 60x 18x 18x 60x 10x 10x 60x 9x 9x 94x 14x 14x 14x 53x 53x 53x 53x 53x 53x 53x 53x 53x 94x 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.
*/
'use strict';
// MODULES //
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isMostlySafeCast = require( '@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var empty = require( '@stdlib/ndarray/empty' );
var assign = require( '@stdlib/ndarray/base/assign' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Copies an input ndarray to a new ndarray having the same shape and data type.
*
* @param {ndarray} x - input array
* @param {Options} [options] - function options
* @param {*} [options.dtype] - output array data type (overrides the input array's inferred data type)
* @param {string} [options.order] - specifies whether the output array should be 'row-major' (C-style) or 'column-major' (Fortran-style) (overrides the input array's inferred order)
* @param {string} [options.mode="throw"] - specifies how to handle indices which exceed array dimensions
* @param {StringArray} [options.submode=["throw"]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {TypeError} `dtype` option must be a supported ndarray data type
* @throws {TypeError} `order` option must be a supported order
* @throws {TypeError} must provide valid options
* @returns {ndarray} ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = zeros( [ 2, 2 ] );
* // returns <ndarray>
*
* var y = copy( x );
* // returns <ndarray>
*
* var sh = getShape( y );
* // returns [ 2, 2 ]
*/
function copy( x ) {
var options;
var opts;
var sh;
var dt;
var o;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
}
opts = {};
if ( arguments.length > 1 ) {
options = arguments[ 1 ];
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
dt = getDType( x );
if ( hasOwnProp( options, 'dtype' ) ) {
if ( !isMostlySafeCast( dt, options.dtype ) ) {
throw new TypeError( format( 'invalid option. First argument cannot be safely cast to the specified data type. Input data type: %s. Option: `%s`.', String( dt ), String( options.dtype ) ) );
}
opts.dtype = options.dtype;
} else {
opts.dtype = dt;
}
if ( hasOwnProp( options, 'order' ) ) {
opts.order = options.order;
} else {
opts.order = getOrder( x );
}
if ( hasOwnProp( options, 'mode' ) ) {
opts.mode = options.mode;
}
if ( hasOwnProp( options, 'submode' ) ) {
opts.submode = options.submode;
}
} else {
opts.dtype = getDType( x );
opts.order = getOrder( x );
}
sh = getShape( x );
// Initialize an output array:
o = empty( sh, opts );
// Copy the input array to the output array:
assign( [ x, o ] );
return o;
}
// EXPORTS //
module.exports = copy;
|