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 */
017
018package org.apache.commons.rng.sampling;
019
020import org.apache.commons.rng.UniformRandomProvider;
021
022/**
023 * Applies to samplers that can share state between instances. Samplers can be created with a
024 * new source of randomness that sample from the same state.
025 *
026 * @param <R> Type of the sampler.
027 * @since 1.3
028 */
029public interface SharedStateSampler<R> {
030    /**
031     * Create a new instance of the sampler with the same underlying state using the given
032     * uniform random provider as the source of randomness.
033     *
034     * @param rng Generator of uniformly distributed random numbers.
035     * @return the sampler
036     */
037    R withUniformRandomProvider(UniformRandomProvider rng);
038}