xref: /freebsd/lib/msun/man/trunc.3 (revision 7ffaea80214760846ec28f383577ac7ba546921a)
1.\" Copyright (c) 2004 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.\" $FreeBSD$
26.\"
27.Dd June 20, 2004
28.Dt TRUNC 3
29.Os
30.Sh NAME
31.Nm trunc ,
32.Nm truncf
33.Nd nearest integral value with magnitude less than or equal to |x|
34.Sh LIBRARY
35.Lb libm
36.Sh SYNOPSIS
37.In math.h
38.Ft double
39.Fn trunc "double x"
40.Ft float
41.Fn truncf "float x"
42.Sh DESCRIPTION
43The
44.Fn trunc
45and
46.Fn truncf
47functions return the nearest integral value with magnitude less than
48or equal to
49.Pf | Fa x Ns | .
50They are equivalent to
51.Fn rint
52and
53.Fn rintf ,
54respectively, in the
55.Dv FE_TOWARDZERO
56rounding mode.
57.Sh SEE ALSO
58.Xr ceil 3 ,
59.Xr fesetround 3 ,
60.Xr floor 3 ,
61.Xr math 3 ,
62.Xr nextafter 3 ,
63.Xr rint 3 ,
64.Xr round 3
65.Sh STANDARDS
66The
67.Fn trunc
68and
69.Fn truncf
70functions conform to
71.St -isoC-99 .
72.Sh HISTORY
73These routines first appeared in
74.Fx 5.3 .
75