man3/trunc.3

   1 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   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.
  12 .\"
  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.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH TRUNC 3  2021-03-22 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 trunc, truncf, truncl \- round to integer, toward zero
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <math.h>
  31 .PP
  32 .BI "double trunc(double " x );
  33 .BI "float truncf(float " x );
  34 .BI "long double truncl(long double " x );
  35 .fi
  36 .PP
  37 Link with \fI\-lm\fP.
  38 .PP
  39 .RS -4
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .RE
  43 .PP
  44 .BR trunc (),
  45 .BR truncf (),
  46 .BR truncl ():
  47 .nf
  48     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  49 .fi
  50 .SH DESCRIPTION
  51 These functions round
  52 .I x
  53 to the nearest integer value that is not larger in magnitude than
  54 .IR x .
  55 .SH RETURN VALUE
  56 These functions return the rounded integer value, in floating format.
  57 .PP
  58 If
  59 .I x
  60 is integral, infinite, or NaN,
  61 .I x
  62 itself is returned.
  63 .SH ERRORS
  64 No errors occur.
  65 .SH VERSIONS
  66 These functions first appeared in glibc in version 2.1.
  67 .SH ATTRIBUTES
  68 For an explanation of the terms used in this section, see
  69 .BR attributes (7).
  70 .ad l
  71 .nh
  72 .TS
  73 allbox;
  74 lbx lb lb
  75 l l l.
  76 Interface       Attribute       Value
  77 T{
  78 .BR trunc (),
  79 .BR truncf (),
  80 .BR truncl ()
  81 T}      Thread safety   MT-Safe
  82 .TE
  83 .hy
  84 .ad
  85 .sp 1
  86 .SH CONFORMING TO
  87 C99, POSIX.1-2001, POSIX.1-2008.
  88 .SH NOTES
  89 The integral value returned by these functions may be too large
  90 to store in an integer type
  91 .RI ( int ,
  92 .IR long ,
  93 etc.).
  94 To avoid an overflow, which will produce undefined results,
  95 an application should perform a range check on the returned value
  96 before assigning it to an integer type.
  97 .SH SEE ALSO
  98 .BR ceil (3),
  99 .BR floor (3),
 100 .BR lrint (3),
 101 .BR nearbyint (3),
 102 .BR rint (3),
 103 .BR round (3)