mathjs/src/function/matrix/flatten.js

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif

'use strict'

const clone = require('../../utils/object').clone
const _flatten = require('../../utils/array').flatten

function factory (type, config, load, typed) {
  const matrix = load(require('../../type/matrix/function/matrix'))

  /**
   * Flatten a multi dimensional matrix into a single dimensional matrix.
   *
   * 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
   */
  const flatten = typed('flatten', {
    'Array': function (x) {
      return _flatten(clone(x))
    },

    'Matrix': function (x) {
      const flat = _flatten(clone(x.toArray()))
      // TODO: return the same matrix type as x
      return matrix(flat)
    }
  })

  flatten.toTex = undefined // use default template

  return flatten
}

exports.name = 'flatten'
exports.factory = factory