Package jsl.modeling.elements.variable

Interface BatchStatisticsIfc

  • public interface BatchStatisticsIfc

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getReplicationAcrossBatchAverage()
      A convenience method to get the within replication batch average from the underlying StatisticalObserver For other statistics use getReplicationBatchStatistic()
      StatisticAccessorIfc getReplicationBatchStatistic()
      Returns a StatisticAccessorIfc for the within replication batching statistics that have been collected on this ResponseVariable.
      boolean isBatchingOn()
      Indicates whether or not the response variable has batching turned on, either by default or by its own choosing.
      boolean isDefaultBatchingOn()
      Gets the batching option flag that indicates whether or not this time weighted variable will allow the model's batching event to perform time based batching.
      void setAcrossBatchStatisticName​(java.lang.String name)  
      void setBatchingOption​(boolean option)
      Indicates whether or not the response variable has batching turned on, either by default or by its own choosing.
      void setBatchingParameters​(int minNumBatches, int minBatchSize, int maxNBMultiple)
      Sets the parameters for batch statistics for the underlying statistical observer

    • Method Detail

      • isDefaultBatchingOn

        boolean isDefaultBatchingOn()
        Gets the batching option flag that indicates whether or not this time weighted variable will allow the model's batching event to perform time based batching.
        Returns:
        True means it will allow

      • isBatchingOn

        boolean isBatchingOn()
        Indicates whether or not the response variable has batching turned on, either by default or by its own choosing. In other words, whether it will be batched. This if false by default, and will be set to true if: 1) the response variable participates in default batching or 2) the user sets this directly
        Returns:
        True means it will be batched

      • setBatchingOption

        void setBatchingOption​(boolean option)
        Indicates whether or not the response variable has batching turned on, either by default or by its own choosing. In other words, whether it will be batched. This is false by default, and will be set to true if: 1) the response variable participates in default batching or 2) the user sets this directly
        Parameters:
        option -

      • getReplicationBatchStatistic

        StatisticAccessorIfc getReplicationBatchStatistic()
        Returns a StatisticAccessorIfc for the within replication batching statistics that have been collected on this ResponseVariable.
        Returns:

      • getReplicationAcrossBatchAverage

        double getReplicationAcrossBatchAverage()
        A convenience method to get the within replication batch average from the underlying StatisticalObserver For other statistics use getReplicationBatchStatistic()
        Returns:

      • setBatchingParameters

        void setBatchingParameters​(int minNumBatches,
                           int minBatchSize,
                           int maxNBMultiple)
        Sets the parameters for batch statistics for the underlying statistical observer
        Parameters:
        minNumBatches - The minimum number of batches, must be >= 2
        minBatchSize - The minimum number of observations per batch, must be >= 2
        maxNBMultiple - The maximum number of batches as a multiple of the minimum number of batches. For example, if minNB = 20 and maxNBMultiple = 2 then the maximum number of batches allowed will be 40. maxNBMultiple must be >= 2.

      • setAcrossBatchStatisticName

        void setAcrossBatchStatisticName​(java.lang.String name)