simple-squiggle/node_modules/mathjs/lib/esm/function/matrix/flatten.js

41 lines
1.1 KiB
JavaScript

import { clone } from '../../utils/object.js';
import { flatten as flattenArray } from '../../utils/array.js';
import { factory } from '../../utils/factory.js';
var name = 'flatten';
var dependencies = ['typed', 'matrix'];
export var createFlatten = /* #__PURE__ */factory(name, dependencies, _ref => {
var {
typed,
matrix
} = _ref;
/**
* Flatten a multi dimensional matrix into a single dimensional matrix.
* It is guaranteed to always return a clone of the argument.
*
* Syntax:
*
* math.flatten(x)
*
* Examples:
*
* math.flatten([[1,2], [3,4]]) // returns [1, 2, 3, 4]
*
* See also:
*
* concat, resize, size, squeeze
*
* @param {Matrix | Array} x Matrix to be flattened
* @return {Matrix | Array} Returns the flattened matrix
*/
return typed(name, {
Array: function Array(x) {
return flattenArray(clone(x));
},
Matrix: function Matrix(x) {
var flat = flattenArray(clone(x.toArray())); // TODO: return the same matrix type as x
return matrix(flat);
}
});
});