original/man3/abs.3

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