xref: /freebsd/lib/msun/man/trunc.3 (revision 06c3fb27)
1.\" Copyright (c) 2004, 2005 David Schultz <das@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd April 16, 2005
26.Dt TRUNC 3
27.Os
28.Sh NAME
29.Nm trunc ,
30.Nm truncf ,
31.Nm truncl
32.Nd nearest integral value with magnitude less than or equal to |x|
33.Sh LIBRARY
34.Lb libm
35.Sh SYNOPSIS
36.In math.h
37.Ft double
38.Fn trunc "double x"
39.Ft float
40.Fn truncf "float x"
41.Ft "long double"
42.Fn truncl "long double x"
43.Sh DESCRIPTION
44The
45.Fn trunc ,
46.Fn truncf ,
47and
48.Fn truncl
49functions return the nearest integral value with magnitude less than
50or equal to
51.Pf | Fa x Ns | .
52They are equivalent to
53.Fn rint ,
54.Fn rintf ,
55and
56.Fn rintl ,
57respectively, in the
58.Dv FE_TOWARDZERO
59rounding mode.
60.Sh SEE ALSO
61.Xr ceil 3 ,
62.Xr fesetround 3 ,
63.Xr floor 3 ,
64.Xr math 3 ,
65.Xr nextafter 3 ,
66.Xr rint 3 ,
67.Xr round 3
68.Sh STANDARDS
69The
70.Fn trunc ,
71.Fn truncf ,
72and
73.Fn truncl
74functions conform to
75.St -isoC-99 .
76.Sh HISTORY
77These routines first appeared in
78.Fx 5.3 .
79