commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ObjectSampler.java

/*
 * 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.stream.Stream;

/**
 * Sampler that generates values of a specified type.
 *
 * @param <T> Type of the sample.
 * @since 1.4
 */
public interface ObjectSampler<T> {
    /**
     * Create an object sample.
     *
     * @return a sample.
     */
    T sample();

    /**
     * Returns an effectively unlimited stream of object sample values.
     *
     * <p>The default implementation produces a sequential stream that repeatedly
     * calls {@link #sample sample}().
     *
     * @return a stream of object values.
     * @since 1.5
     */
    default Stream<T> samples() {
        return Stream.generate(this::sample).sequential();
    }

    /**
     * Returns a stream producing the given {@code streamSize} number of object
     * sample values.
     *
     * <p>The default implementation produces a sequential stream that repeatedly
     * calls {@link #sample sample}(); the stream is limited to the given {@code streamSize}.
     *
     * @param streamSize Number of values to generate.
     * @return a stream of object values.
     * @since 1.5
     */
    default Stream<T> samples(long streamSize) {
        return samples().limit(streamSize);
    }
}