File: func_trigonometric.md

package info (click to toggle)
python-pyglm 2.8.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,008 kB
  • sloc: cpp: 53,029; python: 3,683; makefile: 7
file content (135 lines) | stat: -rw-r--r-- 6,817 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
[//]: # (generated using SlashBack 0.2.0)

  
# func\_trigonometric methods  
The following methods are all part of the **func\_trigonometric methods**\.  
Function parameters specified as angle are assumed to be in units of radians\.  
## Table of contents  
  
* [**acos** function](#acos-function)  
* [**acosh** function](#acosh-function)  
* [**asin** function](#asin-function)  
* [**asinh** function](#asinh-function)  
* [**atan** function](#atan-function)  
* [**atanh** function](#atanh-function)  
* [**cos** function](#cos-function)  
* [**cosh** function](#cosh-function)  
* [**degrees** function](#degrees-function)  
* [**radians** function](#radians-function)  
* [**sin** function](#sin-function)  
* [**sinh** function](#sinh-function)  
* [**tan** function](#tan-function)  
* [**tanh** function](#tanh-function)  
  
### acos\(\) function  
#### <code>glm.<code>**acos**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc cosine\. Returns an angle whose cosine is ``` x ```\. The range of values returned by this function  
&emsp;&emsp;is ``` [0, PI] ```\. Results are undefined if ``` |x| > 1 ```\.  
  
#### <code>glm.<code>**acos**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` acos(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### acosh\(\) function  
#### <code>glm.<code>**acosh**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc hyperbolic cosine; returns the non\-negative inverse of ``` cosh ```\. Results are undefined  
&emsp;&emsp;if ``` x < 1 ```\.  
  
#### <code>glm.<code>**acosh**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` acosh(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### asin\(\) function  
#### <code>glm.<code>**asin**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc sine\. Returns an angle whose sine is ``` x ```\. The range of values returned by this function  
&emsp;&emsp;is ``` [0, PI] ```\. Results are undefined if ``` |x| > 1 ```\.  
  
#### <code>glm.<code>**asin**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` asin(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### asinh\(\) function  
#### <code>glm.<code>**asinh**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc hyperbolic sine; returns the inverse of ``` sinh ```\.  
  
#### <code>glm.<code>**asinh**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` asinh(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### atan\(\) function  
#### <code>glm.<code>**atan**(**y_over_x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc tangent\. Returns an angle whose tangent is ``` y_over_x ```\. The range of values returned by  
&emsp;&emsp;this function is ``` [-PI / 2, PI / 2] ```\.  
  
#### <code>glm.<code>**atan**(**y_over_x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` atan(c) ``` for every component ``` c ``` of ``` x ```\.  
  
#### <code>glm.<code>**atan**(**y**: *float*, **x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc tangent\. Returns an angle whose tangent is ``` y / x ```\. The signs of ``` x ``` and ``` y ``` are used to  
&emsp;&emsp;determine what quadrant the angle is in\. The range of values returned by this function  
&emsp;&emsp;is ``` [-PI, PI] ```\. Results are undefined if ``` x ``` and ``` y ``` are both ``` 0 ```\.  
  
#### <code>glm.<code>**atan**(**y**: *vecN*, **x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` atan(y[i], x[i]) ``` for every index ``` i ```\.  
  
### atanh\(\) function  
#### <code>glm.<code>**atanh**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Arc hyperbolic tangent; returns the inverse of ``` tanh ```\. Results are undefined if ``` abs(x) >= 1 ```\.  
  
#### <code>glm.<code>**atanh**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` atanh(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### cos\(\) function  
#### <code>glm.<code>**cos**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;The standard trigonometric cosine function\. The values returned by this function will range  
&emsp;&emsp;from ``` [-1, 1] ```\.  
  
#### <code>glm.<code>**cos**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` cos(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### cosh\(\) function  
#### <code>glm.<code>**cosh**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the hyperbolic cosine function, ``` (exp(angle) + exp(-angle)) / 2 ```\.  
  
#### <code>glm.<code>**cosh**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` cosh(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### degrees\(\) function  
#### <code>glm.<code>**degrees**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Converts radians to degrees and returns the result\.  
  
#### <code>glm.<code>**degrees**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` degrees(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### radians\(\) function  
#### <code>glm.<code>**radians**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Converts degrees to radians and returns the result\.  
  
#### <code>glm.<code>**radians**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` radians(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### sin\(\) function  
#### <code>glm.<code>**sin**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;The standard trigonometric sine function\. The values returned by this function will range  
&emsp;&emsp;from ``` [-1, 1] ```\.  
  
#### <code>glm.<code>**sin**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` sin(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### sinh\(\) function  
#### <code>glm.<code>**sinh**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the hyperbolic sine function, ``` (exp(angle) - exp(-angle)) / 2 ```\.  
  
#### <code>glm.<code>**sinh**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` sinh(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### tan\(\) function  
#### <code>glm.<code>**tan**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;The standard trigonometric tangent function\.  
  
#### <code>glm.<code>**tan**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` tan(c) ``` for every component ``` c ``` of ``` x ```\.  
  
### tanh\(\) function  
#### <code>glm.<code>**tanh**(**angle**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the hyperbolic tangent function, ``` sinh(angle) / cosh(angle) ```  
  
#### <code>glm.<code>**tanh**(**angle**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Returns ``` tanh(c) ``` for every component ``` c ``` of ``` x ```\.