]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>. |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
4 | .\" Permission is granted to make and distribute verbatim copies of this |
5 | .\" manual provided the copyright notice and this permission notice are | |
6 | .\" preserved on all copies. | |
7 | .\" | |
8 | .\" Permission is granted to copy and distribute modified versions of this | |
9 | .\" manual under the conditions for verbatim copying, provided that the | |
10 | .\" entire resulting derived work is distributed under the terms of a | |
11 | .\" permission notice identical to this one. | |
c13182ef | 12 | .\" |
fea681da MK |
13 | .\" Since the Linux kernel and libraries are constantly changing, this |
14 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
15 | .\" responsibility for errors or omissions, or for damages resulting from | |
16 | .\" the use of the information contained herein. The author(s) may not | |
17 | .\" have taken the same level of care in the production of this manual, | |
18 | .\" which is licensed free of charge, as they might when working | |
19 | .\" professionally. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da | 24 | .\" |
f9293d98 | 25 | .TH TRUNC 3 2013-06-21 "" "Linux Programmer's Manual" |
fea681da | 26 | .SH NAME |
5fab2e7c | 27 | trunc, truncf, truncl \- round to integer, toward zero |
fea681da MK |
28 | .SH SYNOPSIS |
29 | .nf | |
30 | .B #include <math.h> | |
31 | .sp | |
32 | .BI "double trunc(double " x ); | |
33 | .br | |
34 | .BI "float truncf(float " x ); | |
35 | .br | |
36 | .BI "long double truncl(long double " x ); | |
37 | .fi | |
38 | .sp | |
cc4615cc MK |
39 | Link with \fI\-lm\fP. |
40 | .sp | |
41 | .in -4n | |
42 | Feature Test Macro Requirements for glibc (see | |
43 | .BR feature_test_macros (7)): | |
44 | .in | |
45 | .sp | |
46 | .ad l | |
47 | .BR trunc (), | |
48 | .BR truncf (), | |
49 | .BR truncl (): | |
5161d9e0 | 50 | .RS 4 |
d6585dbe MK |
51 | _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE || |
52 | _POSIX_C_SOURCE\ >=\ 200112L; | |
5161d9e0 MK |
53 | .br |
54 | or | |
cc4615cc | 55 | .I cc\ -std=c99 |
5161d9e0 MK |
56 | .RE |
57 | .ad | |
fea681da | 58 | .SH DESCRIPTION |
022671eb MK |
59 | These functions round |
60 | .I x | |
61 | to the nearest integer | |
fea681da | 62 | not larger in absolute value. |
47297adb | 63 | .SH RETURN VALUE |
f1ab30a7 MK |
64 | These functions return the rounded integer value. |
65 | ||
022671eb | 66 | If |
51700fd7 | 67 | .IR x |
022671eb MK |
68 | is integral, infinite, or NaN, |
69 | .I x | |
70 | itself is returned. | |
fea681da | 71 | .SH ERRORS |
f1ab30a7 | 72 | No errors occur. |
f0d7ce1d MK |
73 | .SH VERSIONS |
74 | These functions first appeared in glibc in version 2.1. | |
d265b8f2 PH |
75 | .SH ATTRIBUTES |
76 | .SS Multithreading (see pthreads(7)) | |
77 | The | |
78 | .BR trunc (), | |
79 | .BR truncf (), | |
80 | and | |
81 | .BR truncl () | |
82 | functions are thread-safe. | |
47297adb | 83 | .SH CONFORMING TO |
f1ab30a7 MK |
84 | C99, POSIX.1-2001. |
85 | .SH NOTES | |
86 | The integral value returned by these functions may be too large | |
87 | to store in an integer type | |
88 | .RI ( int , | |
89 | .IR long , | |
90 | etc.). | |
91 | To avoid an overflow, which will produce undefined results, | |
92 | an application should perform a range check on the returned value | |
93 | before assigning it to an integer type. | |
47297adb | 94 | .SH SEE ALSO |
fea681da MK |
95 | .BR ceil (3), |
96 | .BR floor (3), | |
97 | .BR lrint (3), | |
98 | .BR nearbyint (3), | |
99 | .BR rint (3), | |
100 | .BR round (3) |