Class PercentileArrayFunction

java.lang.Object
microsim.statistics.functions.AbstractFunction
microsim.statistics.functions.AbstractArrayFunction
microsim.statistics.functions.PercentileArrayFunction
All Implemented Interfaces:
EventListener, IDoubleSource, IUpdatableSource
@Deprecated(forRemoval=true) public class PercentileArrayFunction extends AbstractArrayFunction implements IDoubleSource
Deprecated, for removal: This API element is subject to removal in a future version.
use Stats
This function calculates percentiles (p1,p5,p10-p90,p95,p99) for a given cross section of data. Input currently must be doubleArray double[].
Author:
Patryk Bronka

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PercentileArrayFunction.Variables
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected double
    p1
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p10
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p20
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p25
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p30
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p40
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p5
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p50
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p60
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p70
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p75
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p80
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p90
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p95
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    p99
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Fields inherited from class AbstractArrayFunction

    dblSource, fltSource, intSource, lngSource, type, TYPE_DBL, TYPE_FLT, TYPE_INT, TYPE_LNG

    Fields inherited from class AbstractFunction

    timeChecker

  • Constructor Summary

    Constructors
    Constructor
    Description
    PercentileArrayFunction(IDoubleArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a percentile function on a double array source.
    PercentileArrayFunction(IFloatArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a percentile function on a float array source.
    PercentileArrayFunction(IIntArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a percentile function on an integer array source.
    PercentileArrayFunction(ILongArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a percentile function on a long array source.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    apply(double[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of double values.
    void
    apply(float[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of float values.
    void
    apply(int[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of integer values.
    void
    apply(long[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of long values.
    double
    getDoubleValue(Enum<?> variableID)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the double value corresponding to the given variableID

    Methods inherited from class AbstractArrayFunction

    applyFunction

    Methods inherited from class AbstractFunction

    isCheckingTime, onEvent, setCheckingTime, updateSource

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • p1

      protected double p1
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p5

      protected double p5
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p10

      protected double p10
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p20

      protected double p20
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p25

      protected double p25
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p30

      protected double p30
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p40

      protected double p40
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p50

      protected double p50
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p60

      protected double p60
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p70

      protected double p70
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p75

      protected double p75
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p80

      protected double p80
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p90

      protected double p90
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p95

      protected double p95
      Deprecated, for removal: This API element is subject to removal in a future version.

    • p99

      protected double p99
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • PercentileArrayFunction

      public PercentileArrayFunction(IFloatArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a percentile function on a float array source.
      Parameters:
      source - The data source.

    • PercentileArrayFunction

      public PercentileArrayFunction(IIntArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a percentile function on an integer array source.
      Parameters:
      source - The data source.

    • PercentileArrayFunction

      public PercentileArrayFunction(ILongArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a percentile function on a long array source.
      Parameters:
      source - The data source.

    • PercentileArrayFunction

      public PercentileArrayFunction(IDoubleArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a percentile function on a double array source.
      Parameters:
      source - The data source.

  • Method Details

    • apply

      public void apply(double[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of double values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(float[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of float values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(int[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of integer values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(long[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of long values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • getDoubleValue

      public double getDoubleValue(Enum<?> variableID)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IDoubleSource
      Return the double value corresponding to the given variableID
      Specified by:
      getDoubleValue in interface IDoubleSource
      Parameters:
      variableID - A unique identifier for a variable.
      Returns:
      The current double value of the required variable.