xref: /minix3/lib/libc/stdlib/div.3 (revision f14fb602092e015ff630df58e17c2a9cd57d29b3)

.\"	$NetBSD: div.3,v 1.14 2011/05/03 09:36:24 wiz Exp $
.\"
.\" 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
.\" Chris Torek.
.\" 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. 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.
.\"
.\"     from: @(#)div.3	8.1 (Berkeley) 6/4/93
.\"
.Dd April 13, 2011
.Dt DIV 3
.Os
.Sh NAME
.Nm div ,
.Nm ldiv ,
.Nm lldiv ,
.Nm imaxdiv
.Nd quotient and remainder from division
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft div_t
.Fn div "int num" "int denom"
.Ft ldiv_t
.Fn ldiv "long int num" "long int denom"
.Ft lldiv_t
.Fn lldiv "long long int num" "long long int denom"
.In inttypes.h
.Ft imaxdiv_t
.Fn imaxdiv "intmax_t num" "intmax_t denom"
.Sh DESCRIPTION
These functions compute the value of
.Fa num / denom
and return the quotient and remainder in a specific divison structure.
The functions differ only with respect to the type of the return value and
the parameters.
.Pp
The returned structure always contains two members named
.Vt quot
and
.Vt rem ,
denoting the quotient and the remainder.
The type of these correspond with the underlying type of the function.
.Sh EXAMPLES
The following example demonstrate the basic usage of the functions.
.Bd -literal -offset indent
div_t d;

int a = 4321;
int b = 1234;

d = div(a, b);

(void)printf("%d %d\en", d.quot, d.rem);
.Ed
.Sh SEE ALSO
.Xr fast_divide32 3 ,
.Xr math 3 ,
.Xr qdiv 3
.Sh STANDARDS
All described functions conform to
.St -isoC-99 .