simple-squiggle

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

column.md (683B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function column
      4 
      5 Return a column from a Matrix.
      6 
      7 
      8 ## Syntax
      9 
     10 ```js
     11 math.column(value, index)
     12 ```
     13 
     14 ### Parameters
     15 
     16 Parameter | Type | Description
     17 --------- | ---- | -----------
     18 `value` | Array &#124; Matrix | An array or matrix
     19 `column` | number | The index of the column
     20 
     21 ### Returns
     22 
     23 Type | Description
     24 ---- | -----------
     25 Array &#124; Matrix | The retrieved column
     26 
     27 
     28 ### Throws
     29 
     30 Type | Description
     31 ---- | -----------
     32 
     33 
     34 ## Examples
     35 
     36 ```js
     37 // get a column
     38 const d = [[1, 2], [3, 4]]
     39 math.column(d, 1) // returns [[2], [4]]
     40 ```
     41 
     42 
     43 ## See also
     44 
     45 [row](row.md)