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$
  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 .Nd next representable value
  41 .Sh LIBRARY
  42 .Lb libm
  43 .Sh SYNOPSIS
  44 .In math.h
  45 .Ft double
  46 .Fn nextafter "double x" "double y"
  47 .Ft float
  48 .Fn nextafterf "float x" "float y"
  49 .Ft long double
  50 .Fn nextafterl "long double x" "long double y"
  51 .Ft double
  52 .Fn nexttoward "double x" "long double y"
  53 .Ft float
  54 .Fn nexttowardf "float x" "long double y"
  55 .Sh DESCRIPTION
  56 These functions
  57 return the next machine representable number from
  58 .Fa x
  59 in direction
  60 .Fa y .
  61 .Sh SEE ALSO
  62 .Xr math 3
  63 .Sh STANDARDS
  64 The
  65 .Fn nextafter ,
  66 .Fn nextafterf ,
  67 .Fn nextafterl ,
  68 .Fn nexttoward ,
  69 and
  70 .Fn nexttowardf
  71 routines conform to
  72 .St -isoC-99 .
  73 They implement the Nextafter function recommended by
  74 .St -ieee754 ,
  75 with the extension that
  76 .Fn nextafter +0.0, -0.0
  77 returns
  78 .Li -0.0 ,
  79 and
  80 .Fn nextafter -0.0, +0.0
  81 returns
  82 .Li +0.0 .
  83 .Sh HISTORY
  84 The
  85 .Fn nextafter
  86 function appeared in
  87 .Bx 4.3 ,
  88 and
  89 .Fn nextafterf
  90 appeared in
  91 .Fx 2.0 .
  92 .Fn nextafterl
  93 appeared in
  94 .Dx 2.13 .