using System;
using Unity.Collections;
using Unity.Jobs;
using UnityEngine;

namespace UnityEngine.Experimental.Perception.Randomization.Samplers
{
    /// <summary>
    /// Generates random values from probability distributions
    /// </summary>
    public interface ISampler
    {
        /// <summary>
        /// A range bounding the values generated by this sampler
        /// </summary>
        FloatRange range { get; set; }

        /// <summary>
        /// Generates one sample
        /// </summary>
        /// <returns>The generated sample</returns>
        float Sample();

        /// <summary>
        /// Schedules a job to generate an array of samples
        /// </summary>
        /// <param name="sampleCount">The number of samples to generate</param>
        /// <param name="jobHandle">The handle of the scheduled job</param>
        /// <returns>A NativeArray of generated samples</returns>
        NativeArray<float> Samples(int sampleCount, out JobHandle jobHandle);

        /// <summary>
        /// Used for performing sampler specific clean-up tasks (e.g. once the scenario is complete).
        /// </summary>
        void Cleanup();

        /// <summary>
        /// Used for performing sampler specific initialization tasks.
        /// </summary>
        void Initialize();
    }
}