original/man3/abs.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Mon Mar 29 22:31:13 1993, David Metcalfe
  30 .\" Modified Sun Jun  6 23:27:50 1993, David Metcalfe
  31 .\" Modified Sat Jul 24 21:45:37 1993, Rik Faith (faith@cs.unc.edu)
  32 .\" Modified Sat Dec 16 15:02:59 2000, Joseph S. Myers
  33 .\"
  34 .TH ABS 3  2010-09-20 "GNU" "Linux Programmer's Manual"
  35 .SH NAME
  36 abs, labs, llabs, imaxabs \- compute the absolute value of an integer
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <stdlib.h>
  40 .sp
  41 .BI "int abs(int " j );
  42 .br
  43 .BI "long int labs(long int " j );
  44 .br
  45 .BI "long long int llabs(long long int " j );
  46 .sp
  47 .B #include <inttypes.h>
  48 .sp
  49 .BI "intmax_t imaxabs(intmax_t " j );
  50 .fi
  51 .sp
  52 .in -4n
  53 Feature Test Macro Requirements for glibc (see
  54 .BR feature_test_macros (7)):
  55 .in
  56 .sp
  57 .ad l
  58 .BR llabs ():
  59 .RS 4
  60 _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  61 _POSIX_C_SOURCE\ >=\ 200112L;
  62 .br
  63 or
  64 .I cc\ -std=c99
  65 .RE
  66 .ad
  67 .SH DESCRIPTION
  68 The
  69 .BR abs ()
  70 function computes the absolute value of the integer
  71 argument \fIj\fP.
  72 The
  73 .BR labs (),
  74 .BR llabs ()
  75 and
  76 .BR imaxabs ()
  77 functions compute the absolute value of the argument \fIj\fP of the
  78 appropriate integer type for the function.
  79 .SH RETURN VALUE
  80 Returns the absolute value of the integer argument, of the appropriate
  81 integer type for the function.
  82 .SH CONFORMING TO
  83 SVr4, POSIX.1-2001, 4.3BSD, C99.
  84 .\" POSIX.1 (1996 edition) only requires the
  85 .\" .BR abs ()
  86 .\" function.
  87 C89 only
  88 includes the
  89 .BR abs ()
  90 and
  91 .BR labs ()
  92 functions; the functions
  93 .BR llabs ()
  94 and
  95 .BR imaxabs ()
  96 were added in C99.
  97 .SH NOTES
  98 Trying to take the absolute value of the most negative integer
  99 is not defined.
 100 .PP
 101 The
 102 .BR llabs ()
 103 function is included in glibc since version 2.0, but
 104 is not in libc5 or libc4.
 105 The
 106 .BR imaxabs ()
 107 function is included in
 108 glibc since version 2.1.1.
 109 .PP
 110 For
 111 .BR llabs ()
 112 to be declared, it may be necessary to define
 113 \fB_ISOC99_SOURCE\fP or \fB_ISOC9X_SOURCE\fP (depending on the
 114 version of glibc) before including any standard headers.
 115 .PP
 116 GCC handles
 117 .BR abs ()
 118 and
 119 .BR labs ()
 120 as built-in functions.
 121 GCC 3.0 also handles
 122 .BR llabs ()
 123 and
 124 .BR imaxabs ()
 125 as built-ins.
 126 .SH SEE ALSO
 127 .BR cabs (3),
 128 .BR ceil (3),
 129 .BR fabs (3),
 130 .BR floor (3),
 131 .BR rint (3)