squeeze.js 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createSqueeze = void 0;
  6. var _object = require("../../utils/object.js");
  7. var _array = require("../../utils/array.js");
  8. var _factory = require("../../utils/factory.js");
  9. var name = 'squeeze';
  10. var dependencies = ['typed', 'matrix'];
  11. var createSqueeze = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  12. var typed = _ref.typed,
  13. matrix = _ref.matrix;
  14. /**
  15. * Squeeze a matrix, remove inner and outer singleton dimensions from a matrix.
  16. *
  17. * Syntax:
  18. *
  19. * math.squeeze(x)
  20. *
  21. * Examples:
  22. *
  23. * math.squeeze([3]) // returns 3
  24. * math.squeeze([[3]]) // returns 3
  25. *
  26. * const A = math.zeros(3, 1) // returns [[0], [0], [0]] (size 3x1)
  27. * math.squeeze(A) // returns [0, 0, 0] (size 3)
  28. *
  29. * const B = math.zeros(1, 3) // returns [[0, 0, 0]] (size 1x3)
  30. * math.squeeze(B) // returns [0, 0, 0] (size 3)
  31. *
  32. * // only inner and outer dimensions are removed
  33. * const C = math.zeros(2, 1, 3) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
  34. * math.squeeze(C) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
  35. *
  36. * See also:
  37. *
  38. * subset
  39. *
  40. * @param {Matrix | Array} x Matrix to be squeezed
  41. * @return {Matrix | Array} Squeezed matrix
  42. */
  43. return typed(name, {
  44. Array: function Array(x) {
  45. return (0, _array.squeeze)((0, _object.clone)(x));
  46. },
  47. Matrix: function Matrix(x) {
  48. var res = (0, _array.squeeze)(x.toArray());
  49. // FIXME: return the same type of matrix as the input
  50. return Array.isArray(res) ? matrix(res) : res;
  51. },
  52. any: function any(x) {
  53. // scalar
  54. return (0, _object.clone)(x);
  55. }
  56. });
  57. });
  58. exports.createSqueeze = createSqueeze;