[apple/libc.git] / stdlib / FreeBSD / imaxdiv.3

.\" Copyright (c) 2001 Mike Barcroft <mike@FreeBSD.org>
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD: src/lib/libc/stdlib/imaxdiv.3,v 1.2 2001/11/21 16:19:50 ru Exp $
.\"
.Dd November 14, 2001
.Dt IMAXDIV 3
.Os
.Sh NAME
.Nm imaxdiv
.Nd returns quotient and remainder
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In inttypes.h
.Ft imaxdiv_t
.Fn imaxdiv "intmax_t numer" "intmax_t denom"
.Sh DESCRIPTION
The
.Fn imaxdiv
function computes the value of
.Fa numer
divided by
.Fa denom
and returns the stored result in the form of the
.Vt imaxdiv_t
type.
.Pp
The
.Vt imaxdiv_t
type is defined as:
.Bd -literal -offset indent
typedef struct {
	intmax_t quot; /* Quotient. */
	intmax_t rem;  /* Remainder. */
} imaxdiv_t;
.Ed
.Sh SEE ALSO
.Xr div 3 ,
.Xr ldiv 3 ,
.Xr lldiv 3 ,
.Xr math 3
.Sh STANDARDS
The
.Fn imaxdiv
function conforms to
.St -isoC-99 .
.Sh HISTORY
The
.Fn imaxdiv
function first appeared in
.Fx 5.0 .
Commit	Line	Data
9385eb3d A	1	.\" Copyright (c) 2001 Mike Barcroft <mike@FreeBSD.org>
9385eb3d A	2	.\" All rights reserved.
e9ce8d39 A	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
e9ce8d39	12	.\"
9385eb3d	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
e9ce8d39 A	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
e9ce8d39 A	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
9385eb3d	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
e9ce8d39 A	17	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	18	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	19	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	21	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	22	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	23	.\" SUCH DAMAGE.
	24	.\"
9385eb3d	25	.\" $FreeBSD: src/lib/libc/stdlib/imaxdiv.3,v 1.2 2001/11/21 16:19:50 ru Exp $
e9ce8d39	26	.\"
9385eb3d A	27	.Dd November 14, 2001
9385eb3d A	28	.Dt IMAXDIV 3
e9ce8d39 A	29	.Os
e9ce8d39 A	30	.Sh NAME
9385eb3d A	31	.Nm imaxdiv
9385eb3d A	32	.Nd returns quotient and remainder
e9ce8d39 A	33	.Sh LIBRARY
	34	.Lb libc
	35	.Sh SYNOPSIS
9385eb3d A	36	.In inttypes.h
	37	.Ft imaxdiv_t
	38	.Fn imaxdiv "intmax_t numer" "intmax_t denom"
e9ce8d39 A	39	.Sh DESCRIPTION
e9ce8d39 A	40	The
9385eb3d A	41	.Fn imaxdiv
	42	function computes the value of
	43	.Fa numer
	44	divided by
	45	.Fa denom
	46	and returns the stored result in the form of the
	47	.Vt imaxdiv_t
	48	type.
	49	.Pp
	50	The
	51	.Vt imaxdiv_t
	52	type is defined as:
	53	.Bd -literal -offset indent
	54	typedef struct {
	55	intmax_t quot; /* Quotient. */
	56	intmax_t rem; /* Remainder. */
	57	} imaxdiv_t;
	58	.Ed
e9ce8d39	59	.Sh SEE ALSO
9385eb3d A	60	.Xr div 3 ,
	61	.Xr ldiv 3 ,
	62	.Xr lldiv 3 ,
	63	.Xr math 3
5b2abdfb	64	.Sh STANDARDS
e9ce8d39	65	The
9385eb3d	66	.Fn imaxdiv
5b2abdfb	67	function conforms to
9385eb3d A	68	.St -isoC-99 .
	69	.Sh HISTORY
	70	The
	71	.Fn imaxdiv
	72	function first appeared in
	73	.Fx 5.0 .