(* Copyright (C) 2005-2023 Free Software Foundation, Inc. *)
(* This file is part of Chisel.

Chisel is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

Chisel is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with gm2; see the file COPYING.  If not, write to the Free Software
Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *)

DEFINITION MODULE Chance ;

(*
   Title      : Chance
   Author     : Gaius Mulley
   Date       : 19/7/88
   LastEdit   : 19/7/88
   System     : LOGITECH MODULA-2/86
   Description: Provides a set of utilities for random numbers.
*)

EXPORT QUALIFIED InitRandom, KillRandom,
                 GetAndDeleteRandom, AddRandom, GetRand, GetSeed, SetSeed ;

(*
   InitRandom - Initializes a potential list of random numbers.
                An index to this potential random number list is returned.
*)

PROCEDURE InitRandom () : CARDINAL ;


(*
   KillRandom - Kills a complete list of random numbers.
*)

PROCEDURE KillRandom (RandomListIndex: CARDINAL) ;


(*
   GetAndDeleteRandom - Returns a random number from the
                        list and then it is deleted.
                        Numbers 1..n will be returned if they exist,
                        if 0 is returned then the list is empty.
*)

PROCEDURE GetAndDeleteRandom (RandomListIndex: CARDINAL) : CARDINAL ;


(*
   AddRandom - places a list of numbers 1..n into the specified list.
*)

PROCEDURE AddRandom (RandomListIndex: CARDINAL; n: CARDINAL) ;


(*
   GetRand - returns a number between 0..n-1.
             This routine is independant from the above routines.
*)

PROCEDURE GetRand (n: CARDINAL) : CARDINAL ;


(*
   SetSeed - use, n, as the seed to pseudo random numbers.
*)

PROCEDURE SetSeed (n: CARDINAL) ;


(*
   GetSeed - return the seed used to create pseudo random numbers.
*)

PROCEDURE GetSeed () : CARDINAL ;


END Chance.