lib/libc/stdlib/abs.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)abs.3       8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/stdlib/abs.3,v 1.7.2.3 2001/12/14 18:33:58 ru Exp $
  38 .\" $DragonFly: src/lib/libc/stdlib/abs.3,v 1.4 2007/12/02 03:29:47 swildner Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt ABS 3
  42 .Os
  43 .Sh NAME
  44 .Nm abs
  45 .Nd integer absolute value function
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdlib.h
  50 .Ft int
  51 .Fn abs "int j"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn abs
  55 function
  56 computes
  57 the absolute value of the integer
  58 .Ar j .
  59 .Sh IMPLEMENTATION NOTES
  60 The
  61 .Fn abs
  62 function is thread-safe.
  63 It is not async-cancel-safe.
  64 .Sh RETURN VALUES
  65 The
  66 .Fn abs
  67 function
  68 returns
  69 the absolute value.
  70 .Sh SEE ALSO
  71 .Xr cabs 3 ,
  72 .Xr fabs 3 ,
  73 .Xr floor 3 ,
  74 .Xr hypot 3 ,
  75 .Xr imaxabs 3 ,
  76 .Xr labs 3 ,
  77 .Xr llabs 3 ,
  78 .Xr math 3
  79 .Sh STANDARDS
  80 The
  81 .Fn abs
  82 function conforms to
  83 .St -isoC .
  84 .Sh BUGS
  85 The absolute value of the most negative integer remains negative.