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