simple-squiggle/node_modules/mathjs/lib/cjs/function/matrix/reshape.js

72 lines
2.2 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.createReshape = void 0;
var _array = require("../../utils/array.js");
var _factory = require("../../utils/factory.js");
var name = 'reshape';
var dependencies = ['typed', 'isInteger', 'matrix'];
var createReshape = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
var typed = _ref.typed,
isInteger = _ref.isInteger;
/**
* Reshape a multi dimensional array to fit the specified dimensions
*
* Syntax:
*
* math.reshape(x, sizes)
*
* Examples:
*
* math.reshape([1, 2, 3, 4, 5, 6], [2, 3])
* // returns Array [[1, 2, 3], [4, 5, 6]]
*
* math.reshape([[1, 2], [3, 4]], [1, 4])
* // returns Array [[1, 2, 3, 4]]
*
* math.reshape([[1, 2], [3, 4]], [4])
* // returns Array [1, 2, 3, 4]
*
* const x = math.matrix([1, 2, 3, 4, 5, 6, 7, 8])
* math.reshape(x, [2, 2, 2])
* // returns Matrix [[[1, 2], [3, 4]], [[5, 6], [7, 8]]]
*
* math.reshape([1, 2, 3, 4], [-1, 2])
* // returns Matrix [[1, 2], [3, 4]]
*
* See also:
*
* size, squeeze, resize
*
* @param {Array | Matrix | *} x Matrix to be reshaped
* @param {number[]} sizes One dimensional array with integral sizes for
* each dimension. One -1 is allowed as wildcard,
* which calculates this dimension automatically.
*
* @return {* | Array | Matrix} A reshaped clone of matrix `x`
*
* @throws {TypeError} If `sizes` does not contain solely integers
* @throws {DimensionError} If the product of the new dimension sizes does
* not equal that of the old ones
*/
return typed(name, {
'Matrix, Array': function MatrixArray(x, sizes) {
return x.reshape(sizes);
},
'Array, Array': function ArrayArray(x, sizes) {
sizes.forEach(function (size) {
if (!isInteger(size)) {
throw new TypeError('Invalid size for dimension: ' + size);
}
});
return (0, _array.reshape)(x, sizes);
}
});
});
exports.createReshape = createReshape;