1 |
|
2 |
|
3 | # Function typeOf
|
4 |
|
5 | Determine the type of a variable.
|
6 |
|
7 | Function `typeOf` recognizes the following types of objects:
|
8 |
|
9 | Object | Returns | Example
|
10 | ---------------------- | ------------- | ------------------------------------------
|
11 | null | `'null'` | `math.typeOf(null)`
|
12 | number | `'number'` | `math.typeOf(3.5)`
|
13 | boolean | `'boolean'` | `math.typeOf(true)`
|
14 | string | `'string'` | `math.typeOf('hello world')`
|
15 | Array | `'Array'` | `math.typeOf([1, 2, 3])`
|
16 | Date | `'Date'` | `math.typeOf(new Date())`
|
17 | Function | `'Function'` | `math.typeOf(function () {})`
|
18 | Object | `'Object'` | `math.typeOf({a: 2, b: 3})`
|
19 | RegExp | `'RegExp'` | `math.typeOf(/a regexp/)`
|
20 | undefined | `'undefined'` | `math.typeOf(undefined)`
|
21 | math.BigNumber | `'BigNumber'` | `math.typeOf(math.bignumber('2.3e500'))`
|
22 | math.Chain | `'Chain'` | `math.typeOf(math.chain(2))`
|
23 | math.Complex | `'Complex'` | `math.typeOf(math.complex(2, 3))`
|
24 | math.Fraction | `'Fraction'` | `math.typeOf(math.fraction(1, 3))`
|
25 | math.Help | `'Help'` | `math.typeOf(math.help('sqrt'))`
|
26 | math.Help | `'Help'` | `math.typeOf(math.help('sqrt'))`
|
27 | math.Index | `'Index'` | `math.typeOf(math.index(1, 3))`
|
28 | math.Matrix | `'Matrix'` | `math.typeOf(math.matrix([[1,2], [3, 4]]))`
|
29 | math.Range | `'Range'` | `math.typeOf(math.range(0, 10))`
|
30 | math.ResultSet | `'ResultSet'` | `math.typeOf(math.evaluate('a=2\nb=3'))`
|
31 | math.Unit | `'Unit'` | `math.typeOf(math.unit('45 deg'))`
|
32 | math.AccessorNode | `'AccessorNode'` | `math.typeOf(math.parse('A[2]'))`
|
33 | math.ArrayNode | `'ArrayNode'` | `math.typeOf(math.parse('[1,2,3]'))`
|
34 | math.AssignmentNode | `'AssignmentNode'` | `math.typeOf(math.parse('x=2'))`
|
35 | math.BlockNode | `'BlockNode'` | `math.typeOf(math.parse('a=2; b=3'))`
|
36 | math.ConditionalNode | `'ConditionalNode'` | `math.typeOf(math.parse('x<0 ? -x : x'))`
|
37 | math.ConstantNode | `'ConstantNode'` | `math.typeOf(math.parse('2.3'))`
|
38 | math.FunctionAssignmentNode | `'FunctionAssignmentNode'` | `math.typeOf(math.parse('f(x)=x^2'))`
|
39 | math.FunctionNode | `'FunctionNode'` | `math.typeOf(math.parse('sqrt(4)'))`
|
40 | math.IndexNode | `'IndexNode'` | `math.typeOf(math.parse('A[2]').index)`
|
41 | math.ObjectNode | `'ObjectNode'` | `math.typeOf(math.parse('{a:2}'))`
|
42 | math.ParenthesisNode | `'ParenthesisNode'` | `math.typeOf(math.parse('(2+3)'))`
|
43 | math.RangeNode | `'RangeNode'` | `math.typeOf(math.parse('1:10'))`
|
44 | math.SymbolNode | `'SymbolNode'` | `math.typeOf(math.parse('x'))`
|
45 |
|
46 |
|
47 | ## Syntax
|
48 |
|
49 | ```js
|
50 | math.typeOf(x)
|
51 | ```
|
52 |
|
53 | ### Parameters
|
54 |
|
55 | Parameter | Type | Description
|
56 | --------- | ---- | -----------
|
57 | `x` | * | The variable for which to test the type.
|
58 |
|
59 | ### Returns
|
60 |
|
61 | Type | Description
|
62 | ---- | -----------
|
63 | string | Returns the name of the type. Primitive types are lower case, non-primitive types are upper-camel-case. For example 'number', 'string', 'Array', 'Date'.
|
64 |
|
65 |
|
66 | ## Examples
|
67 |
|
68 | ```js
|
69 | math.typeOf(3.5) // returns 'number'
|
70 | math.typeOf(math.complex('2-4i')) // returns 'Complex'
|
71 | math.typeOf(math.unit('45 deg')) // returns 'Unit'
|
72 | math.typeOf('hello world') // returns 'string'
|
73 | ```
|
74 |
|
75 |
|