NetBSD/lib/libc/stdlib/rand.3

104 lines
3.2 KiB
Groff
Raw Normal View History

.\" $NetBSD: rand.3,v 1.7 1998/04/28 04:07:06 fair Exp $
1995-12-28 11:51:55 +03:00
.\"
1998-01-31 02:37:40 +03:00
.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. 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.
.\"
1998-01-31 02:37:40 +03:00
.\" from: @(#)rand.3 8.1 (Berkeley) 6/4/93
1993-03-21 12:45:37 +03:00
.\"
1998-01-31 02:37:40 +03:00
.Dd June 4, 1993
1993-03-21 12:45:37 +03:00
.Dt RAND 3
.Os
.Sh NAME
.Nm rand ,
1997-07-15 04:42:01 +04:00
.Nm srand ,
.Nm rand_r
1993-03-21 12:45:37 +03:00
.Nd bad random number generator
1998-02-05 21:45:17 +03:00
.Sh LIBRARY
.Lb libc
1993-03-21 12:45:37 +03:00
.Sh SYNOPSIS
.Fd #include <stdlib.h>
.Ft void
1997-07-15 04:42:01 +04:00
.Fn srand "unsigned int seed"
1993-03-21 12:45:37 +03:00
.Ft int
.Fn rand void
1997-07-15 04:42:01 +04:00
.Ft int
.Fn rand_r "unsigned int *seed"
1993-03-21 12:45:37 +03:00
.Sh DESCRIPTION
.Bf -symbolic
These interfaces are obsoleted by
.Xr random 3 .
1993-03-21 12:45:37 +03:00
.Ef
.Pp
The
.Fn rand
function computes a sequence of pseudo-random integers in the range
of 0 to
.Dv RAND_MAX
(as defined by the header file
.Aq Pa stdlib.h ) .
.Pp
The
.Fn srand
function sets its argument as the seed for a new sequence of
pseudo-random numbers to be returned by
.Fn rand .
These sequences are repeatable by calling
.Fn srand
with the same seed value.
.Pp
1997-07-15 04:42:01 +04:00
If no seed value is provided, the
.Fn rand
function is automatically seeded with a value of 1.
.Pp
The
.Fn rand_r
function is a reentrant interface to
.Fn rand ;
the seed has to be supplied and is maintained by the caller.
1993-03-21 12:45:37 +03:00
.Sh SEE ALSO
.Xr random 3
.Sh STANDARDS
The
.Fn rand
and
.Fn srand
functions
conform to
.St -ansiC .
1997-07-15 04:42:01 +04:00
The
.Fn rand_r
function conforms to
.St -p1003.1c-95 .