simple-squiggle

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

oct.md (631B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function oct
      4 
      5 Format a number as octal.
      6 
      7 
      8 ## Syntax
      9 
     10 ```js
     11 math.oct(value)
     12 ```
     13 
     14 ### Parameters
     15 
     16 Parameter | Type | Description
     17 --------- | ---- | -----------
     18 `value` | number | Value to be stringified
     19 `wordSize` | number | Optional word size (see `format`)
     20 
     21 ### Returns
     22 
     23 Type | Description
     24 ---- | -----------
     25 string | The formatted value
     26 
     27 
     28 ### Throws
     29 
     30 Type | Description
     31 ---- | -----------
     32 
     33 
     34 ## Examples
     35 
     36 ```js
     37 //the following outputs "0o70"
     38 math.oct(56)
     39 ```
     40 
     41 
     42 ## See also
     43 
     44 [bin](bin.md),
     45 [hex](hex.md)