Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MATH-899 

Added wrapper class that allows thread-safe usage of any "RandomGenerator".


git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1410990 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gilles Sadowski 2012-11-18 21:00:34 +00:00
parent 2a75c2afdc
commit cca05f0c71
2 changed files with 127 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/changes/changes.xml
View File

@ -52,6 +52,11 @@ If the output is not quite correct, check for invisible trailing spaces!
<body>
<release version="3.1" date="TBD" description="
">
<action dev="erans" type="add" issue="MATH-899">
Added a new "SynchronizedRandomGenerator" that wraps another
"RandomGenerator" with all methods being synchronized, thus
rendering the code thread-safe (at some efficiency cost).
</action>
<action dev="tn" type="add" issue="MATH-893" due-to="Patrick Meyer">
Add new "NaNStrategy": FAILED, used in "RankingAlgorithm" implementations.
Any encountered input value that succeeds a "Double#isNaN" check, results in a

122
src/main/java/org/apache/commons/math3/random/SynchronizedRandomGenerator.java Normal file
View File

@ -0,0 +1,122 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.random;
/**
* Any {@link RandomGenerator} implementation can be thread-safe if it
* is used through an instance of this class.
* This is achieved by enclosing calls to the methods of the actual
* generator inside the overridden {@code synchronized} methods of this
* class.
*
* @since 3.1
* @version $Id$
*/
public class SynchronizedRandomGenerator implements RandomGenerator {
/** Object to which all calls will be delegated. */
private final RandomGenerator wrapped;
/**
* Creates a synchronized wrapper for the given {@code RandomGenerator}
* instance.
*
* @param rng Generator whose methods will be called through
* their corresponding overridden synchronized version.
* To ensure thread-safety, the wrapped generator <em>must</em>
* not be used directly.
*/
public SynchronizedRandomGenerator(RandomGenerator rng) {
wrapped = rng;
}
/**
* {@inheritDoc}
*/
public synchronized void setSeed(int seed) {
wrapped.setSeed(seed);
}
/**
* {@inheritDoc}
*/
public synchronized void setSeed(int[] seed) {
wrapped.setSeed(seed);
}
/**
* {@inheritDoc}
*/
public synchronized void setSeed(long seed) {
wrapped.setSeed(seed);
}
/**
* {@inheritDoc}
*/
public synchronized void nextBytes(byte[] bytes) {
wrapped.nextBytes(bytes);
}
/**
* {@inheritDoc}
*/
public synchronized int nextInt() {
return wrapped.nextInt();
}
/**
* {@inheritDoc}
*/
public synchronized int nextInt(int n) {
return wrapped.nextInt();
}
/**
* {@inheritDoc}
*/
public synchronized long nextLong() {
return wrapped.nextLong();
}
/**
* {@inheritDoc}
*/
public synchronized boolean nextBoolean() {
return wrapped.nextBoolean();
}
/**
* {@inheritDoc}
*/
public synchronized float nextFloat() {
return wrapped.nextFloat();
}
/**
* {@inheritDoc}
*/
public synchronized double nextDouble() {
return wrapped.nextDouble();
}
/**
* {@inheritDoc}
*/
public synchronized double nextGaussian() {
return wrapped.nextGaussian();
}
}