simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

flatten.md (774B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function flatten
      4 
      5 Flatten a multi dimensional matrix into a single dimensional matrix.
      6 It is guaranteed to always return a clone of the argument.
      7 
      8 
      9 ## Syntax
     10 
     11 ```js
     12 math.flatten(x)
     13 ```
     14 
     15 ### Parameters
     16 
     17 Parameter | Type | Description
     18 --------- | ---- | -----------
     19 `x` | Matrix &#124; Array | Matrix to be flattened
     20 
     21 ### Returns
     22 
     23 Type | Description
     24 ---- | -----------
     25 Matrix &#124; Array | Returns the flattened matrix
     26 
     27 
     28 ### Throws
     29 
     30 Type | Description
     31 ---- | -----------
     32 
     33 
     34 ## Examples
     35 
     36 ```js
     37 math.flatten([[1,2], [3,4]])   // returns [1, 2, 3, 4]
     38 ```
     39 
     40 
     41 ## See also
     42 
     43 [concat](concat.md),
     44 [resize](resize.md),
     45 [size](size.md),
     46 [squeeze](squeeze.md)