lib/libm/man/trunc.3

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd December 21, 2011
  28 .Dt TRUNC 3
  29 .Os
  30 .Sh NAME
  31 .Nm trunc ,
  32 .Nm truncf ,
  33 .Nm truncl
  34 .Nd nearest integral value with magnitude less than or equal to |x|
  35 .Sh LIBRARY
  36 .Lb libm
  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
  46 The
  47 .Fn trunc ,
  48 .Fn truncf ,
  49 and
  50 .Fn truncl
  51 functions return the nearest integral value with magnitude less than
  52 or equal to
  53 .Pf | Fa x Ns | .
  54 They are equivalent to
  55 .Fn rint ,
  56 .Fn rintf ,
  57 and
  58 .Fn rintl ,
  59 respectively, in the
  60 .Dv FE_TOWARDZERO
  61 rounding mode.
  62 .Sh SEE ALSO
  63 .Xr ceil 3 ,
  64 .Xr fesetround 3 ,
  65 .Xr floor 3 ,
  66 .Xr math 3 ,
  67 .Xr nextafter 3 ,
  68 .Xr rint 3 ,
  69 .Xr round 3
  70 .Sh STANDARDS
  71 The
  72 .Fn trunc ,
  73 .Fn truncf ,
  74 and
  75 .Fn truncl
  76 functions conform to
  77 .St -isoC-99 .
  78 .Sh HISTORY
  79 These routines first appeared in
  80 .Dx 1.9 .
  81 The long double version appeared in
  82 .Dx 2.13 .