1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: Random.java,v 1.4 2005/09/10 14:05:52 mat007 Exp $
29 */
30
31 package jtge.util.random;
32
33 /***
34 * An instance of this class is used to generate a stream of pseudorandom numbers. Its basically a wrapper for
35 * java.util.Random class with more high-level functionalities.
36 * <p>
37 * The behavior is stricly the same as java.util.Random, which is used internally.
38 *
39 * @author jeanlaurent
40 * @version $Revision: 1.4 $ $Date: 2005/09/10 14:05:52 $
41 */
42 public class Random extends java.util.Random implements IRandom
43 {
44 private static final long serialVersionUID = -4104488496769431583L;
45 /***
46 * the traced seed used by this object.
47 */
48 private long seed;
49
50 /***
51 * Builds a default Random Object.
52 * @see java.util.Random#Random()
53 */
54 public Random()
55 {
56
57 }
58
59 /***
60 * @see java.util.Random#Random(long)
61 * @param seed the initial seed
62 */
63 public Random( final long seed )
64 {
65 super( seed );
66 this.seed = seed;
67 }
68
69 /***
70 * @see java.util.Random#setSeed(long)
71 */
72 public final synchronized void setSeed( final long seed )
73 {
74 super.setSeed( seed );
75 this.seed = seed;
76 }
77
78 /***
79 * Returns the current seed used by this Random object.
80 *
81 * @return the current seed used by this Random object.
82 */
83 public final synchronized long getSeed()
84 {
85 return seed;
86 }
87
88 /***
89 * Returns a float in the range [0.0, maxVal[.
90 * <p>
91 * This method is implemented as :<blockquote>
92 *
93 * <pre>
94 * return nextFloat() * maxVal;
95 * </pre>
96 *
97 * </blockquote>
98 *
99 * @see java.util.Random#nextFloat()
100 * @param maxVal the maximum value
101 * @return float
102 */
103 public final float nextFloat( final float maxVal )
104 {
105 return nextFloat() * maxVal;
106 }
107 }