com.opengamma.strata.math.impl.statistics.descriptive.SamplePlusOneNearestIndexQuantileMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of strata-math Show documentation

Mathematic support for Strata

There is a newer version: 2.12.46

/*
 * Copyright (C) 2015 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.math.impl.statistics.descriptive;

/**
 * Implementation of a quantile estimator.
 * 
 * The estimation is one of the sorted sample data. Its index is given by the nearest (Math.round) integer to the
 * quantile multiplied by the size of the sample plus one.
 * The Java index is the above index minus 1 (array index start at 0 and not 1).
 * 
 * Reference: Value-At-Risk, OpenGamma Documentation 31, Version 0.1, April 2015.
 */
public final class SamplePlusOneNearestIndexQuantileMethod
    extends DiscreteQuantileMethod {

  /** Default implementation. */
  public static final SamplePlusOneNearestIndexQuantileMethod DEFAULT = new SamplePlusOneNearestIndexQuantileMethod();

  @Override
  int index(double quantileSize) {
    return (int) Math.round(quantileSize);
  }

  @Override
  int sampleCorrection(int sampleSize) {
    return sampleSize + 1;
  }

  @Override
  protected double indexShift() {
    return 0.5;
  }

}