001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.rng.core.source32;
018
019/**
020 * This class implements the WELL44497a pseudo-random number generator
021 * from François Panneton, Pierre L'Ecuyer and Makoto Matsumoto.
022 * <p>
023 * This generator is described in a paper by Fran&ccedil;ois Panneton,
024 * Pierre L'Ecuyer and Makoto Matsumoto
025 * <a href="http://www.iro.umontreal.ca/~lecuyer/myftp/papers/wellrng.pdf">
026 * Improved Long-Period Generators Based on Linear Recurrences Modulo 2</a>
027 * ACM Transactions on Mathematical Software, 32, 1 (2006).
028 * The errata for the paper are in
029 * <a href="http://www.iro.umontreal.ca/~lecuyer/myftp/papers/wellrng-errata.txt">wellrng-errata.txt</a>.
030 * </p>
031 *
032 * @see <a href="http://www.iro.umontreal.ca/~panneton/WELLRNG.html">WELL Random number generator</a>
033 * @since 1.0
034 */
035public class Well44497a extends AbstractWell {
036    /** Number of bits in the pool. */
037    private static final int K = 44497;
038    /** First parameter of the algorithm. */
039    private static final int M1 = 23;
040    /** Second parameter of the algorithm. */
041    private static final int M2 = 481;
042    /** Third parameter of the algorithm. */
043    private static final int M3 = 229;
044    /** The indirection index table. */
045    private static final IndexTable TABLE = new IndexTable(K, M1, M2, M3);
046
047    /**
048     * Creates a new random number generator.
049     *
050     * @param seed Initial seed.
051     */
052    public Well44497a(int[] seed) {
053        super(K, seed);
054    }
055
056    /** {@inheritDoc} */
057    @Override
058    public int next() {
059        final int indexRm1 = TABLE.getIndexPred(index);
060        final int indexRm2 = TABLE.getIndexPred2(index);
061
062        final int v0 = v[index];
063        final int vM1 = v[TABLE.getIndexM1(index)];
064        final int vM2 = v[TABLE.getIndexM2(index)];
065        final int vM3 = v[TABLE.getIndexM3(index)];
066
067        // the values below include the errata of the original article
068        final int z0 = (0xFFFF8000 & v[indexRm1]) ^ (0x00007FFF & v[indexRm2]);
069        final int z1 = (v0 ^ (v0 << 24)) ^ (vM1 ^ (vM1 >>> 30));
070        final int z2 = (vM2 ^ (vM2 << 10)) ^ (vM3 << 26);
071        final int z3 = z1 ^ z2;
072        final int z2Prime = ((z2 << 9) ^ (z2 >>> 23)) & 0xfbffffff;
073        final int z2Second = ((z2 & 0x00020000) == 0) ? z2Prime : (z2Prime ^ 0xb729fcec);
074        final int z4 = z0 ^ (z1 ^ (z1 >>> 20)) ^ z2Second ^ z3;
075
076        v[index] = z3;
077        v[indexRm1] = z4;
078        v[indexRm2] &= 0xFFFF8000;
079        index = indexRm1;
080
081        return z4;
082    }
083}