Package org.apache.commons.rng.sampling

Interface ObjectSampler<T>

Type Parameters:
T - Type of the sample.
All Known Subinterfaces:
SharedStateObjectSampler<T>
All Known Implementing Classes:
BoxSampler, BoxSampler.BoxSampler2D, BoxSampler.BoxSampler3D, BoxSampler.BoxSamplerND, CollectionSampler, CombinationSampler, CompositeSamplers.ObjectSamplerFactory.CompositeObjectSampler, CompositeSamplers.SharedStateObjectSamplerFactory.CompositeSharedStateObjectSampler, DirichletSampler, DirichletSampler.GeneralDirichletSampler, DirichletSampler.SymmetricDirichletSampler, DiscreteProbabilityCollectionSampler, LineSampler, LineSampler.LineSampler1D, LineSampler.LineSampler2D, LineSampler.LineSampler3D, LineSampler.LineSamplerND, PermutationSampler, TetrahedronSampler, TriangleSampler, TriangleSampler.TriangleSampler2D, TriangleSampler.TriangleSampler3D, TriangleSampler.TriangleSamplerND, UnitBallSampler, UnitBallSampler.UnitBallSampler1D, UnitBallSampler.UnitBallSampler2D, UnitBallSampler.UnitBallSampler3D, UnitBallSampler.UnitBallSamplerND, UnitSphereSampler, UnitSphereSampler.UnitSphereSampler1D, UnitSphereSampler.UnitSphereSampler2D, UnitSphereSampler.UnitSphereSampler3D, UnitSphereSampler.UnitSphereSamplerND
public interface ObjectSampler<T>
Sampler that generates values of a specified type.
Since:
1.4

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    sample()
    Create an object sample.
    default Stream<T>
    samples()
    Returns an effectively unlimited stream of object sample values.
    default Stream<T>
    samples(long streamSize)
    Returns a stream producing the given streamSize number of object sample values.

  • Method Details

    • sample

      T sample()
      Create an object sample.
      Returns:
      a sample.

    • samples

      default Stream<T> samples()
      Returns an effectively unlimited stream of object sample values.

      The default implementation produces a sequential stream that repeatedly calls sample().

      Returns:
      a stream of object values.
      Since:
      1.5

    • samples

      default Stream<T> samples(long streamSize)
      Returns a stream producing the given streamSize number of object sample values.

      The default implementation produces a sequential stream that repeatedly calls sample(); the stream is limited to the given streamSize.

      Parameters:
      streamSize - Number of values to generate.
      Returns:
      a stream of object values.
      Since:
      1.5