lib/libm/man/fegetround.3

   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: src/lib/msun/man/fegetround.3,v 1.2 2005/01/14 09:12:05 ru Exp $
  26 .\"
  27 .Dd May 8, 2004
  28 .Dt FEGETROUND 3
  29 .Os
  30 .Sh NAME
  31 .Nm fegetround ,
  32 .Nm fesetround
  33 .Nd floating-point rounding control
  34 .Sh LIBRARY
  35 .Lb libm
  36 .Sh SYNOPSIS
  37 .In fenv.h
  38 .Fd "#pragma STDC FENV_ACCESS ON"
  39 .Ft int
  40 .Fn fegetround void
  41 .Ft int
  42 .Fn fesetround "int round"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn fegetround
  46 function determines the current floating-point rounding mode,
  47 and the
  48 .Fn fesetround
  49 function sets the current rounding mode to
  50 .Fa round .
  51 The rounding mode is one of
  52 .Dv FE_TONEAREST , FE_DOWNWARD , FE_UPWARD ,
  53 or
  54 .Dv FE_TOWARDZERO ,
  55 as described in
  56 .Xr fenv 3 .
  57 .Sh RETURN VALUES
  58 The
  59 .Fn fegetround
  60 routine returns the current rounding mode.
  61 The
  62 .Fn fesetround
  63 function returns 0 on success and non-zero otherwise;
  64 however, the present implementation always succeeds.
  65 .Sh SEE ALSO
  66 .Xr fenv 3 ,
  67 .Xr fpgetround 3 ,
  68 .Xr fpsetround 3
  69 .Sh STANDARDS
  70 The
  71 .Fn fegetround
  72 and
  73 .Fn fesetround
  74 functions conform to
  75 .St -isoC-99 .
  76 .Sh HISTORY
  77 These routines first appeared in
  78 .Fx 5.3 .
  79 They supersede the non-standard
  80 .Xr fpgetround 3
  81 and
  82 .Xr fpsetround 3
  83 functions.