[apple/libc.git] / stdlib / abs.3

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