123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 |
- import { clone } from '../../utils/object.js';
- import { squeeze as arraySqueeze } from '../../utils/array.js';
- import { factory } from '../../utils/factory.js';
- var name = 'squeeze';
- var dependencies = ['typed', 'matrix'];
- export var createSqueeze = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- typed,
- matrix
- } = _ref;
- /**
- * Squeeze a matrix, remove inner and outer singleton dimensions from a matrix.
- *
- * Syntax:
- *
- * math.squeeze(x)
- *
- * Examples:
- *
- * math.squeeze([3]) // returns 3
- * math.squeeze([[3]]) // returns 3
- *
- * const A = math.zeros(3, 1) // returns [[0], [0], [0]] (size 3x1)
- * math.squeeze(A) // returns [0, 0, 0] (size 3)
- *
- * const B = math.zeros(1, 3) // returns [[0, 0, 0]] (size 1x3)
- * math.squeeze(B) // returns [0, 0, 0] (size 3)
- *
- * // only inner and outer dimensions are removed
- * const C = math.zeros(2, 1, 3) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
- * math.squeeze(C) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
- *
- * See also:
- *
- * subset
- *
- * @param {Matrix | Array} x Matrix to be squeezed
- * @return {Matrix | Array} Squeezed matrix
- */
- return typed(name, {
- Array: function Array(x) {
- return arraySqueeze(clone(x));
- },
- Matrix: function Matrix(x) {
- var res = arraySqueeze(x.toArray());
- // FIXME: return the same type of matrix as the input
- return Array.isArray(res) ? matrix(res) : res;
- },
- any: function any(x) {
- // scalar
- return clone(x);
- }
- });
- });
|