lib/libc/stdlib/div.3

   1 .\"     $NetBSD: div.3,v 1.14 2011/05/03 09:36:24 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Chris Torek.
   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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     from: @(#)div.3 8.1 (Berkeley) 6/4/93
  33 .\"
  34 .Dd April 13, 2011
  35 .Dt DIV 3
  36 .Os
  37 .Sh NAME
  38 .Nm div ,
  39 .Nm ldiv ,
  40 .Nm lldiv ,
  41 .Nm imaxdiv
  42 .Nd quotient and remainder from division
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In stdlib.h
  47 .Ft div_t
  48 .Fn div "int num" "int denom"
  49 .Ft ldiv_t
  50 .Fn ldiv "long int num" "long int denom"
  51 .Ft lldiv_t
  52 .Fn lldiv "long long int num" "long long int denom"
  53 .In inttypes.h
  54 .Ft imaxdiv_t
  55 .Fn imaxdiv "intmax_t num" "intmax_t denom"
  56 .Sh DESCRIPTION
  57 These functions compute the value of
  58 .Fa num / denom
  59 and return the quotient and remainder in a specific divison structure.
  60 The functions differ only with respect to the type of the return value and
  61 the parameters.
  62 .Pp
  63 The returned structure always contains two members named
  64 .Vt quot
  65 and
  66 .Vt rem ,
  67 denoting the quotient and the remainder.
  68 The type of these correspond with the underlying type of the function.
  69 .Sh EXAMPLES
  70 The following example demonstrate the basic usage of the functions.
  71 .Bd -literal -offset indent
  72 div_t d;
  73
  74 int a = 4321;
  75 int b = 1234;
  76
  77 d = div(a, b);
  78
  79 (void)printf("%d %d\en", d.quot, d.rem);
  80 .Ed
  81 .Sh SEE ALSO
  82 .Xr fast_divide32 3 ,
  83 .Xr math 3 ,
  84 .Xr qdiv 3
  85 .Sh STANDARDS
  86 All described functions conform to
  87 .St -isoC-99 .