File: ulp.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 (54 lines) | stat: -rw-r--r-- 2,919 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
[//]: # (generated using SlashBack 0.2.0)

  
# ulp methods  
The following methods are all part of the **ulp methods**\.  
Allow the measurement of the accuracy of a function against a reference implementation\. This extension works on floating\-point data and provide results in ULP\.  
## Table of contents  
  
* [**float\_distance** function](#float_distance-function)  
* [**next\_float** function](#next_float-function)  
* [**prev\_float** function](#prev_float-function)  
  
### float\_distance\(\) function  
#### <code>glm.<code>**float_distance**(**x**: *float*, **y**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Return the distance in the number of ULP between 2 double\-precision floating\-point scalars\.  
  
#### <code>glm.<code>**float_distance**(**x**: *fvecN*, **y**: *fvecN*) -\> *ivecN*</code></code>  
&emsp;&emsp;Return the distance in the number of ULP between 2 single\-precision floating\-point scalars\.  
  
#### <code>glm.<code>**float_distance**(**x**: *dvecN*, **y**: *dvecN*) -\> *i64vecN*</code></code>  
&emsp;&emsp;Return the distance in the number of ULP between 2 double\-precision floating\-point scalars\.  
  
### next\_float\(\) function  
#### <code>glm.<code>**next_float**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Return the next ULP value\(s\) after the input value\(s\)\.  
  
#### <code>glm.<code>**next_float**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Return the next ULP value\(s\) after the input value\(s\)\.  
  
#### <code>glm.<code>**next_float**(**x**: *float*, **ULPs**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Return the next ULP value\(s\) after the input value\(s\)\.  
  
#### <code>glm.<code>**next_float**(**x**: *vecN*, **ULPs**: *float*) -\> *vecN*</code></code>  
&emsp;&emsp;Return the next ULP value\(s\) after the input value\(s\)\.  
  
#### <code>glm.<code>**next_float**(**x**: *vecN*, **ULPs**: *ivecN*) -\> *float*</code></code>  
&emsp;&emsp;Return the next ULP value\(s\) after the input value\(s\)\.  
  
### prev\_float\(\) function  
#### <code>glm.<code>**prev_float**(**x**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Return the previous ULP value\(s\) before the input value\(s\)\.  
  
#### <code>glm.<code>**prev_float**(**x**: *vecN*) -\> *vecN*</code></code>  
&emsp;&emsp;Return the previous ULP value\(s\) before the input value\(s\)\.  
  
#### <code>glm.<code>**prev_float**(**x**: *float*, **ULPs**: *float*) -\> *float*</code></code>  
&emsp;&emsp;Return the previous ULP value\(s\) before the input value\(s\)\.  
  
#### <code>glm.<code>**prev_float**(**x**: *vecN*, **ULPs**: *float*) -\> *vecN*</code></code>  
&emsp;&emsp;Return the previous ULP value\(s\) before the input value\(s\)\.  
  
#### <code>glm.<code>**prev_float**(**x**: *vecN*, **ULPs**: *ivecN*) -\> *float*</code></code>  
&emsp;&emsp;Return the previous ULP value\(s\) before the input value\(s\)\.