lib/libc/stdlib/rand.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   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 .\"
  36 .\"     @(#)rand.3      8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/stdlib/rand.3,v 1.4.2.5 2001/12/14 18:33:58 ru Exp $
  38 .\"
  39 .Dd May 25, 1999
  40 .Dt RAND 3
  41 .Os
  42 .Sh NAME
  43 .Nm rand ,
  44 .Nm srand ,
  45 .Nm rand_r
  46 .Nd bad random number generator
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdlib.h
  51 .Ft void
  52 .Fn srand "unsigned seed"
  53 .Ft int
  54 .Fn rand void
  55 .Ft int
  56 .Fn rand_r "unsigned *ctx"
  57 .Sh DESCRIPTION
  58 .Bf -symbolic
  59 These interfaces are obsoleted by
  60 .Xr random 3 .
  61 .Ef
  62 .Pp
  63 The
  64 .Fn rand
  65 function computes a sequence of pseudo-random integers in the range
  66 of 0 to
  67 .Dv RAND_MAX
  68 (as defined by the header file
  69 .Aq Pa stdlib.h ) .
  70 .Pp
  71 The
  72 .Fn srand
  73 function sets its argument
  74 .Fa seed
  75 as the seed for a new sequence of
  76 pseudo-random numbers to be returned by
  77 .Fn rand .
  78 These sequences are repeatable by calling
  79 .Fn srand
  80 with the same seed value.
  81 .Pp
  82 If no
  83 .Fa seed
  84 value is provided, the functions are automatically
  85 seeded with a value of 1.
  86 .Pp
  87 .Fn rand_r
  88 provides the same functionality as
  89 .Fn rand .
  90 A pointer to the context value
  91 .Fa ctx
  92 must be supplied by the caller.
  93 .Sh SEE ALSO
  94 .Xr random 3
  95 .Sh STANDARDS
  96 The
  97 .Fn rand
  98 and
  99 .Fn srand
 100 functions
 101 conform to
 102 .St -isoC .
 103 .Pp
 104 The
 105 .Fn rand_r
 106 function is as proposed in the POSIX.4a Draft #6 document.