gcc/ada/a-nuflra.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --            A D A . N U M E R I C S . F L O A T _ R A N D O M             --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2015, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  21 --                                                                          --
  22 -- As a special exception under Section 7 of GPL version 3, you are granted --
  23 -- additional permissions described in the GCC Runtime Library Exception,   --
  24 -- version 3.1, as published by the Free Software Foundation.               --
  25 --                                                                          --
  26 -- You should have received a copy of the GNU General Public License and    --
  27 -- a copy of the GCC Runtime Library Exception along with this program;     --
  28 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  29 -- <http://www.gnu.org/licenses/>.                                          --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  Note: the implementation used in this package is a version of the
  37 --  Mersenne Twister. See s-rannum.adb for details and references.
  38
  39 with System.Random_Numbers;
  40
  41 package Ada.Numerics.Float_Random with
  42   SPARK_Mode => Off
  43 is
  44
  45    --  Basic facilities
  46
  47    type Generator is limited private;
  48
  49    subtype Uniformly_Distributed is Float range 0.0 .. 1.0;
  50
  51    function Random (Gen : Generator) return Uniformly_Distributed;
  52
  53    procedure Reset (Gen : Generator);
  54    procedure Reset (Gen : Generator; Initiator : Integer);
  55
  56    --  Advanced facilities
  57
  58    type State is private;
  59
  60    procedure Save  (Gen : Generator; To_State   : out State);
  61    procedure Reset (Gen : Generator; From_State : State);
  62
  63    Max_Image_Width : constant := System.Random_Numbers.Max_Image_Width;
  64
  65    function Image (Of_State    : State)  return String;
  66    function Value (Coded_State : String) return State;
  67
  68 private
  69
  70    type Generator is new System.Random_Numbers.Generator;
  71
  72    type State is new System.Random_Numbers.State;
  73
  74 end Ada.Numerics.Float_Random;