UNPKG

1.31 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function rotate
4
5Rotate a vector of size 1x2 counter-clockwise by a given angle
6Rotate a vector of size 1x3 counter-clockwise by a given angle around the given axis
7
8
9## Syntax
10
11```js
12math.rotate(w, theta)
13math.rotate(w, theta, v)
14```
15
16### Parameters
17
18Parameter | Type | Description
19--------- | ---- | -----------
20`w` | Array &#124; Matrix | Vector to rotate
21`theta` | number &#124; BigNumber &#124; Complex &#124; Unit | Rotation angle
22`v` | Array &#124; Matrix | Rotation axis
23
24### Returns
25
26Type | Description
27---- | -----------
28Array &#124; Matrix | Multiplication of the rotation matrix and w
29
30
31## Examples
32
33```js
34math.rotate([11, 12], math.pi / 2) // returns matrix([-12, 11])
35math.rotate(matrix([11, 12]), math.pi / 2) // returns matrix([-12, 11])
36
37math.rotate([1, 0, 0], unit('90deg'), [0, 0, 1]) // returns matrix([0, 1, 0])
38math.rotate(matrix([1, 0, 0]), unit('90deg'), [0, 0, 1]) // returns matrix([0, 1, 0])
39
40math.rotate([1, 0], math.complex(1 + i)) // returns matrix([cos(1 + i) - sin(1 + i), sin(1 + i) + cos(1 + i)])
41```
42
43
44## See also
45
46[matrix](matrix.md),
47[rotationMatrix](rotationMatrix.md)