lib/libm/man/nextafter.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   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 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)ieee.3        6.4 (Berkeley) 5/6/91
  29 .\" $FreeBSD: head/lib/msun/man/nextafter.3 165906 2007-01-09 01:02:06Z imp $
  30 .\"
  31 .Dd December 21, 2011
  32 .Dt NEXTAFTER 3
  33 .Os
  34 .Sh NAME
  35 .Nm nextafter ,
  36 .Nm nextafterf ,
  37 .Nm nextafterl ,
  38 .Nm nexttoward ,
  39 .Nm nexttowardf ,
  40 .Nm nexttowardl
  41 .Nd next representable value
  42 .Sh LIBRARY
  43 .Lb libm
  44 .Sh SYNOPSIS
  45 .In math.h
  46 .Ft double
  47 .Fn nextafter "double x" "double y"
  48 .Ft float
  49 .Fn nextafterf "float x" "float y"
  50 .Ft long double
  51 .Fn nextafterl "long double x" "long double y"
  52 .Ft double
  53 .Fn nexttoward "double x" "long double y"
  54 .Ft float
  55 .Fn nexttowardf "float x" "long double y"
  56 .Ft long double
  57 .Fn nexttowardl "long double x" "long double y"
  58 .Sh DESCRIPTION
  59 These functions
  60 return the next machine representable number from
  61 .Fa x
  62 in direction
  63 .Fa y .
  64 .Sh SEE ALSO
  65 .Xr ieee 3 ,
  66 .Xr math 3
  67 .Sh STANDARDS
  68 The
  69 .Fn nextafter ,
  70 .Fn nextafterf ,
  71 .Fn nextafterl ,
  72 .Fn nexttoward ,
  73 .Fn nexttowardf ,
  74 and
  75 .Fn nexttowardl
  76 routines conform to
  77 .St -isoC-99 .
  78 They implement the Nextafter function recommended by
  79 .St -ieee754 ,
  80 with the extension that
  81 .Fn nextafter +0.0, -0.0
  82 returns
  83 .Li -0.0 ,
  84 and
  85 .Fn nextafter -0.0, +0.0
  86 returns
  87 .Li +0.0 .
  88 .Sh HISTORY
  89 The
  90 .Fn nextafter
  91 function appeared in
  92 .Bx 4.3 ,
  93 and
  94 .Fn nextafterf
  95 appeared in
  96 .Fx 2.0 .