org.apache.commons.rng.sampling.CollectionSampler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-rng-sampling Show documentation
The Apache Commons RNG Sampling module provides samplers for various distributions.
The newest version!
/*
 * 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.rng.sampling;

import java.util.Collection;
import java.util.List;
import java.util.ArrayList;

import org.apache.commons.rng.UniformRandomProvider;

/**
 * Sampling from a {@link Collection}.
 *
 * Sampling uses {@link UniformRandomProvider#nextInt(int)}.
 *
 * @param  Type of items in the collection.
 *
 * @since 1.0
 */
public class CollectionSampler implements SharedStateObjectSampler {
    /** Collection to be sampled from. */
    private final List items;
    /** RNG. */
    private final UniformRandomProvider rng;

    /**
     * Creates a sampler.
     *
     * @param rng Generator of uniformly distributed random numbers.
     * @param collection Collection to be sampled.
     * A (shallow) copy will be stored in the created instance.
     * @throws IllegalArgumentException if {@code collection} is empty.
     */
    public CollectionSampler(UniformRandomProvider rng,
                             Collection collection) {
        this(rng, toList(collection));
    }

    /**
     * @param rng Generator of uniformly distributed random numbers.
     * @param collection Collection to be sampled.
     */
    private CollectionSampler(UniformRandomProvider rng,
                              List collection) {
        this.rng = rng;
        items = collection;
    }

    /**
     * Picks one of the items from the
     * {@link #CollectionSampler(UniformRandomProvider,Collection)
     * collection passed to the constructor}.
     *
     * @return a random sample.
     */
    @Override
    public T sample() {
        return items.get(rng.nextInt(items.size()));
    }

    /**
     * {@inheritDoc}
     *
     * @since 1.3
     */
    @Override
    public CollectionSampler withUniformRandomProvider(UniformRandomProvider rng) {
        return new CollectionSampler<>(rng, this.items);
    }

    /**
     * Convert the collection to a list (shallow) copy.
     *
     * This method exists to raise an exception before invocation of the
     * private constructor; this mitigates Finalizer attacks
     * (see SpotBugs CT_CONSTRUCTOR_THROW).
     *
     * @param  Type of items in the collection.
     * @param collection Collection.
     * @return the list copy
     * @throws IllegalArgumentException if {@code collection} is empty.
     */
    private static  List toList(Collection collection) {
        if (collection.isEmpty()) {
            throw new IllegalArgumentException("Empty collection");
        }
        return new ArrayList<>(collection);
    }
}