File: func_exponential.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 (88 lines) | stat: -rw-r--r-- 4,152 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
[//]: # (generated using SlashBack 0.2.0)

  
# func\_exponential methods  
The following methods are all part of the **func\_exponential methods**\.  
It contains exponential GLSL functions\.  
## Table of contents  
  
* [**exp** function](#exp-function)  
* [**exp2** function](#exp2-function)  
* [**inversesqrt** function](#inversesqrt-function)  
* [**log** function](#log-function)  
* [**log2** function](#log2-function)  
* [**pow** function](#pow-function)  
* [**sqrt** function](#sqrt-function)  
  
### exp\(\) function  
#### <code>glm.<code>**exp**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the natural exponentiation of ``` x ```, i\.e\., ``` e^x ```\.  
  
#### <code>glm.<code>**exp**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component c of x:  
&emsp;&emsp;Returns the natural exponentiation of ``` c ```, i\.e\., ``` e^c ```\.  
  
#### <code>glm.<code>**exp**(**x**: *quat*) -\> *quat*</code></code>  
&emsp;&emsp;Returns an exponential of a quaternion\.  
  
### exp2\(\) function  
#### <code>glm.<code>**exp2**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns ``` 2 ``` raised to the ``` x ``` power\.  
  
#### <code>glm.<code>**exp2**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component ``` c ``` of ``` x ```:  
&emsp;&emsp;Returns ``` 2 ``` raised to the ``` c ``` power\.  
  
### inversesqrt\(\) function  
#### <code>glm.<code>**inversesqrt**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the reciprocal of the positive square root of ``` x ```\.  
  
#### <code>glm.<code>**inversesqrt**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component ``` c ``` of ``` x ```:  
&emsp;&emsp;Returns the reciprocal of the positive square root of ``` c ```\.  
  
### log\(\) function  
#### <code>glm.<code>**log**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the natural logarithm of ``` x ```, i\.e\., returns the value ``` y ``` which satisfies the equation  
&emsp;&emsp;``` x = e^y ```\. Results are undefined if ``` x <= 0 ```\.  
  
#### <code>glm.<code>**log**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component ``` c ``` of ``` x ```:  
&emsp;&emsp;Returns the natural logarithm of ``` c ```, i\.e\., returns the value ``` y ``` which satisfies the equation  
&emsp;&emsp;``` c = e^y ```\. Results are undefined if ``` c <= 0 ```\.  
  
#### <code>glm.<code>**log**(**x**: *quat*) -\> *quat*</code></code>  
&emsp;&emsp;Returns a logarithm of a quaternion\.  
  
### log2\(\) function  
#### <code>glm.<code>**log2**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the base ``` 2 ``` log of ``` x ```, i\.e\., returns the value ``` y ```, which satisfies the equation  
&emsp;&emsp;``` x = 2 ^ y ```\.  
  
#### <code>glm.<code>**log2**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component ``` c ``` of ``` x ```:  
&emsp;&emsp;Returns the base ``` 2 ``` log of ``` c ```, i\.e\., returns the value ``` y ```, which satisfies the equation  
&emsp;&emsp;``` c = 2 ^ y ```\.  
  
### pow\(\) function  
#### <code>glm.<code>**pow**(**base**: *float*, **exponent**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns base raised to the power exponent\.  
  
#### <code>glm.<code>**pow**(**base**: *vecN*, **exponent**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every index ``` i ```:  
&emsp;&emsp;Returns ``` base[i] ``` raised to the power ``` exponent[i] ```\.  
  
#### <code>glm.<code>**pow**(**base**: *quat*, **exponent**: *quat*) -\> *quat*</code></code>  
&emsp;&emsp;Returns a quaternion raised to a power\.  
  
### sqrt\(\) function  
#### <code>glm.<code>**sqrt**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Returns the positive square root of ``` x ```\.  
  
#### <code>glm.<code>**sqrt**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;For every component ``` c ``` of ``` x ```:  
&emsp;&emsp;Returns the positive square root of ``` c ```\.  
  
#### <code>glm.<code>**sqrt**(**x**: *quat*) -\> *quat*</code></code>  
&emsp;&emsp;Returns the square root of a quaternion\.