lib/libcr/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 .\" $DragonFly: src/lib/libcr/stdlib/Attic/rand.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd May 25, 1999
  41 .Dt RAND 3
  42 .Os
  43 .Sh NAME
  44 .Nm rand ,
  45 .Nm srand ,
  46 .Nm rand_r
  47 .Nd bad random number generator
  48 .Sh LIBRARY
  49 .Lb libc
  50 .Sh SYNOPSIS
  51 .In stdlib.h
  52 .Ft void
  53 .Fn srand "unsigned seed"
  54 .Ft int
  55 .Fn rand void
  56 .Ft int
  57 .Fn rand_r "unsigned *ctx"
  58 .Sh DESCRIPTION
  59 .Bf -symbolic
  60 These interfaces are obsoleted by
  61 .Xr random 3 .
  62 .Ef
  63 .Pp
  64 The
  65 .Fn rand
  66 function computes a sequence of pseudo-random integers in the range
  67 of 0 to
  68 .Dv RAND_MAX
  69 (as defined by the header file
  70 .Aq Pa stdlib.h ) .
  71 .Pp
  72 The
  73 .Fn srand
  74 function sets its argument
  75 .Fa seed
  76 as the seed for a new sequence of
  77 pseudo-random numbers to be returned by
  78 .Fn rand .
  79 These sequences are repeatable by calling
  80 .Fn srand
  81 with the same seed value.
  82 .Pp
  83 If no
  84 .Fa seed
  85 value is provided, the functions are automatically
  86 seeded with a value of 1.
  87 .Pp
  88 .Fn rand_r
  89 provides the same functionality as
  90 .Fn rand .
  91 A pointer to the context value
  92 .Fa ctx
  93 must be supplied by the caller.
  94 .Sh SEE ALSO
  95 .Xr random 3
  96 .Sh STANDARDS
  97 The
  98 .Fn rand
  99 and
 100 .Fn srand
 101 functions
 102 conform to
 103 .St -isoC .
 104 .Pp
 105 The
 106 .Fn rand_r
 107 function is as proposed in the POSIX.4a Draft #6 document.