Class Quantiles.Scale

  • Enclosing class:
    Quantiles

    public static final class Quantiles.Scale
    extends java.lang.Object
    Describes the point in a fluent API chain where only the scale (i.e. the q in q-quantiles) has been specified.
    Since:
    20.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Quantiles.ScaleAndIndex index​(int index)
      Specifies a single quantile index to be calculated, i.e.
      Quantiles.ScaleAndIndexes indexes​(int... indexes)
      Specifies multiple quantile indexes to be calculated, each index being the k in the kth q-quantile.
      Quantiles.ScaleAndIndexes indexes​(java.util.Collection<java.lang.Integer> indexes)
      Specifies multiple quantile indexes to be calculated, each index being the k in the kth q-quantile.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • index

        public Quantiles.ScaleAndIndex index​(int index)
        Specifies a single quantile index to be calculated, i.e. the k in the kth q-quantile.
        Parameters:
        index - the quantile index, which must be in the inclusive range [0, q] for q-quantiles
      • indexes

        public Quantiles.ScaleAndIndexes indexes​(int... indexes)
        Specifies multiple quantile indexes to be calculated, each index being the k in the kth q-quantile.
        Parameters:
        indexes - the quantile indexes, each of which must be in the inclusive range [0, q] for q-quantiles; the order of the indexes is unimportant, duplicates will be ignored, and the set will be snapshotted when this method is called
        Throws:
        java.lang.IllegalArgumentException - if indexes is empty
      • indexes

        public Quantiles.ScaleAndIndexes indexes​(java.util.Collection<java.lang.Integer> indexes)
        Specifies multiple quantile indexes to be calculated, each index being the k in the kth q-quantile.
        Parameters:
        indexes - the quantile indexes, each of which must be in the inclusive range [0, q] for q-quantiles; the order of the indexes is unimportant, duplicates will be ignored, and the set will be snapshotted when this method is called
        Throws:
        java.lang.IllegalArgumentException - if indexes is empty