lib/libm/man/fegetround.3

   1 .\"     $NetBSD: fegetround.3,v 1.1 2010/07/31 21:47:53 joerg Exp $
   2 .\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd May 8, 2004
  27 .Dt FEGETROUND 3
  28 .Os
  29 .Sh NAME
  30 .Nm fegetround ,
  31 .Nm fesetround
  32 .Nd floating-point rounding control
  33 .Sh LIBRARY
  34 .Lb libm
  35 .Sh SYNOPSIS
  36 .In fenv.h
  37 .Fd "#pragma STDC FENV_ACCESS ON"
  38 .Ft int
  39 .Fn fegetround void
  40 .Ft int
  41 .Fn fesetround "int round"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn fegetround
  45 function determines the current floating-point rounding mode,
  46 and the
  47 .Fn fesetround
  48 function sets the current rounding mode to
  49 .Fa round .
  50 The rounding mode is one of
  51 .Dv FE_TONEAREST , FE_DOWNWARD , FE_UPWARD ,
  52 or
  53 .Dv FE_TOWARDZERO ,
  54 as described in
  55 .Xr fenv 3 .
  56 .Sh RETURN VALUES
  57 The
  58 .Fn fegetround
  59 routine returns the current rounding mode.
  60 The
  61 .Fn fesetround
  62 function returns 0 on success and non-zero otherwise;
  63 however, the present implementation always succeeds.
  64 .Sh SEE ALSO
  65 .Xr fenv 3 ,
  66 .Xr fpgetround 3 ,
  67 .Xr fpsetround 3
  68 .Sh STANDARDS
  69 The
  70 .Fn fegetround
  71 and
  72 .Fn fesetround
  73 functions conform to
  74 .St -isoC-99 .
  75 .Sh HISTORY
  76 These routines first appeared in
  77 .Fx 5.3
  78 and
  79 .Nx 6.0 .
  80 They supersede the non-standard
  81 .Xr fpgetround 3
  82 and
  83 .Xr fpsetround 3
  84 functions.