Various pages: [GPL-2.0-only] Use SPDX-License-Identifier

[thirdparty/man-pages.git] / man3 / abs.3

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified Mon Mar 29 22:31:13 1993, David Metcalfe
.\" Modified Sun Jun  6 23:27:50 1993, David Metcalfe
.\" Modified Sat Jul 24 21:45:37 1993, Rik Faith (faith@cs.unc.edu)
.\" Modified Sat Dec 16 15:02:59 2000, Joseph S. Myers
.\"
.TH ABS 3  2021-03-22 "GNU" "Linux Programmer's Manual"
.SH NAME
abs, labs, llabs, imaxabs \- compute the absolute value of an integer
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
.PP
.BI "int abs(int " j );
.BI "long labs(long " j );
.BI "long long llabs(long long " j );
.PP
.B #include <inttypes.h>
.PP
.BI "intmax_t imaxabs(intmax_t " j );
.fi
.PP
.RS -4
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.RE
.PP
.BR llabs ():
.nf
    _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
.fi
.SH DESCRIPTION
The
.BR abs ()
function computes the absolute value of the integer
argument \fIj\fP.
The
.BR labs (),
.BR llabs (),
and
.BR imaxabs ()
functions compute the absolute value of the argument \fIj\fP of the
appropriate integer type for the function.
.SH RETURN VALUE
Returns the absolute value of the integer argument, of the appropriate
integer type for the function.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.ad l
.nh
.TS
allbox;
lbx lb lb
l l l.
Interface	Attribute	Value
T{
.BR abs (),
.BR labs (),
.BR llabs (),
.BR imaxabs ()
T}	Thread safety	MT-Safe
.TE
.hy
.ad
.sp 1
.SH CONFORMING TO
POSIX.1-2001, POSIX.1-2008, C99, SVr4, 4.3BSD.
.\" POSIX.1 (1996 edition) requires only the
.\" .BR abs ()
.\" function.
C89 only
includes the
.BR abs ()
and
.BR labs ()
functions; the functions
.BR llabs ()
and
.BR imaxabs ()
were added in C99.
.SH NOTES
Trying to take the absolute value of the most negative integer
is not defined.
.PP
The
.BR llabs ()
function is included in glibc since version 2.0.
The
.BR imaxabs ()
function is included in
glibc since version 2.1.1.
.PP
For
.BR llabs ()
to be declared, it may be necessary to define
\fB_ISOC99_SOURCE\fP or \fB_ISOC9X_SOURCE\fP (depending on the
version of glibc) before including any standard headers.
.PP
By default,
GCC handles
.BR abs (),
.BR labs (),
and (since GCC 3.0)
.BR llabs ()
and
.BR imaxabs ()
as built-in functions.
.SH SEE ALSO
.BR cabs (3),
.BR ceil (3),
.BR fabs (3),
.BR floor (3),
.BR rint (3)