| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| package org.apache.datasketches.req; |
| |
| import static org.apache.datasketches.quantilescommon.QuantileSearchCriteria.INCLUSIVE; |
| import static org.apache.datasketches.quantilescommon.QuantilesAPI.EMPTY_MSG; |
| import static org.apache.datasketches.quantilescommon.QuantilesUtil.getNaturalRank; |
| |
| import java.util.List; |
| |
| import org.apache.datasketches.common.SketchesArgumentException; |
| import org.apache.datasketches.quantilescommon.FloatsSortedView; |
| import org.apache.datasketches.quantilescommon.FloatsSortedViewIterator; |
| import org.apache.datasketches.quantilescommon.InequalitySearch; |
| import org.apache.datasketches.quantilescommon.QuantileSearchCriteria; |
| import org.apache.datasketches.quantilescommon.QuantilesAPI; |
| import org.apache.datasketches.quantilescommon.QuantilesUtil; |
| |
| /** |
| * The SortedView of the ReqSketch. |
| * @author Alexander Saydakov |
| * @author Lee Rhodes |
| */ |
| public final class ReqSketchSortedView implements FloatsSortedView { |
| private float[] quantiles; |
| private long[] cumWeights; //comes in as individual weights, converted to cumulative natural weights |
| private final long totalN; |
| private final float maxItem; |
| private final float minItem; |
| |
| /** |
| * Construct from elements for testing. |
| * @param quantiles sorted array of quantiles |
| * @param cumWeights sorted, monotonically increasing cumulative weights. |
| * @param totalN the total number of items presented to the sketch. |
| */ |
| ReqSketchSortedView(final float[] quantiles, final long[] cumWeights, final long totalN, |
| final float maxItem, final float minItem) { |
| this.quantiles = quantiles; |
| this.cumWeights = cumWeights; |
| this.totalN = totalN; |
| this.maxItem = maxItem; |
| this.minItem = minItem; |
| } |
| |
| /** |
| * Constructs this Sorted View given the sketch |
| * @param sketch the given ReqSketch |
| */ |
| public ReqSketchSortedView(final ReqSketch sketch) { |
| if (sketch.isEmpty()) { throw new SketchesArgumentException(EMPTY_MSG); } |
| this.totalN = sketch.getN(); |
| this.maxItem = sketch.getMaxItem(); |
| this.minItem = sketch.getMinItem(); |
| buildSortedViewArrays(sketch); |
| } |
| |
| //end of constructors |
| |
| @Override |
| public long[] getCumulativeWeights() { |
| return cumWeights.clone(); |
| } |
| |
| @Override |
| public float getMaxItem() { |
| return maxItem; |
| } |
| |
| @Override |
| public float getMinItem() { |
| return minItem; |
| } |
| |
| @Override |
| public long getN() { |
| return totalN; |
| } |
| |
| @Override |
| public int getNumRetained() { |
| return quantiles.length; |
| } |
| |
| @Override |
| public float getQuantile(final double rank, final QuantileSearchCriteria searchCrit) { |
| if (isEmpty()) { throw new IllegalArgumentException(QuantilesAPI.EMPTY_MSG); } |
| QuantilesUtil.checkNormalizedRankBounds(rank); |
| final int len = cumWeights.length; |
| final double naturalRank = getNaturalRank(rank, totalN, searchCrit); |
| final InequalitySearch crit = (searchCrit == INCLUSIVE) ? InequalitySearch.GE : InequalitySearch.GT; |
| final int index = InequalitySearch.find(cumWeights, 0, len - 1, naturalRank, crit); |
| if (index == -1) { |
| return quantiles[len - 1]; ///EXCLUSIVE (GT) case: normRank == 1.0; |
| } |
| return quantiles[index]; |
| } |
| |
| @Override |
| public float[] getQuantiles() { |
| return quantiles.clone(); |
| } |
| |
| @Override |
| public double getRank(final float quantile, final QuantileSearchCriteria searchCrit) { |
| if (isEmpty()) { throw new IllegalArgumentException(QuantilesAPI.EMPTY_MSG); } |
| final int len = quantiles.length; |
| final InequalitySearch crit = (searchCrit == INCLUSIVE) ? InequalitySearch.LE : InequalitySearch.LT; |
| final int index = InequalitySearch.find(quantiles, 0, len - 1, quantile, crit); |
| if (index == -1) { |
| return 0; //EXCLUSIVE (LT) case: quantile <= minQuantile; INCLUSIVE (LE) case: quantile < minQuantile |
| } |
| return (double)cumWeights[index] / totalN; |
| } |
| |
| @Override |
| public boolean isEmpty() { |
| return totalN == 0; |
| } |
| |
| @Override |
| public FloatsSortedViewIterator iterator() { |
| return new FloatsSortedViewIterator(quantiles, cumWeights); |
| } |
| |
| //restricted methods |
| |
| private void buildSortedViewArrays(final ReqSketch sk) { |
| final List<ReqCompactor> compactors = sk.getCompactors(); |
| final int numComp = compactors.size(); |
| final int totalQuantiles = sk.getNumRetained(); |
| quantiles = new float[totalQuantiles]; //could have zero entries |
| cumWeights = new long[totalQuantiles]; |
| int count = 0; |
| for (int i = 0; i < numComp; i++) { |
| final ReqCompactor c = compactors.get(i); |
| final FloatBuffer bufIn = c.getBuffer(); |
| final long bufWeight = 1 << c.getLgWeight(); |
| final int bufInLen = bufIn.getCount(); |
| mergeSortIn(bufIn, bufWeight, count, sk.getHighRankAccuracyMode()); |
| count += bufInLen; |
| } |
| createCumulativeNativeRanks(); |
| } |
| |
| /** |
| * Specially modified version of FloatBuffer.mergeSortIn(). Here spaceAtBottom is always false and |
| * the ultimate array size has already been set. However, this must simultaneously deal with |
| * sorting the base FloatBuffer as well. |
| * |
| * @param bufIn given FloatBuffer. If not sorted it will be sorted here. |
| * @param bufWeight associated weight of input FloatBuffer |
| * @param count tracks number of items inserted into the class arrays |
| */ |
| private void mergeSortIn(final FloatBuffer bufIn, final long bufWeight, final int count, final boolean hra) { |
| if (!bufIn.isSorted()) { bufIn.sort(); } |
| final float[] arrIn = bufIn.getArray(); //may be larger than its item count. |
| final int bufInLen = bufIn.getCount(); |
| final int totLen = count + bufInLen; |
| int i = count - 1; |
| int j = bufInLen - 1; |
| int h = hra ? bufIn.getCapacity() - 1 : bufInLen - 1; |
| for (int k = totLen; k-- > 0; ) { |
| if (i >= 0 && j >= 0) { //both valid |
| if (quantiles[i] >= arrIn[h]) { |
| quantiles[k] = quantiles[i]; |
| cumWeights[k] = cumWeights[i--]; //not yet natRanks, just individual wts |
| } else { |
| quantiles[k] = arrIn[h--]; j--; |
| cumWeights[k] = bufWeight; |
| } |
| } else if (i >= 0) { //i is valid |
| quantiles[k] = quantiles[i]; |
| cumWeights[k] = cumWeights[i--]; |
| } else if (j >= 0) { //j is valid |
| quantiles[k] = arrIn[h--]; j--; |
| cumWeights[k] = bufWeight; |
| } else { |
| break; |
| } |
| } |
| } |
| |
| private void createCumulativeNativeRanks() { |
| final int len = quantiles.length; |
| for (int i = 1; i < len; i++) { |
| cumWeights[i] += cumWeights[i - 1]; |
| } |
| if (totalN > 0) { |
| assert cumWeights[len - 1] == totalN; |
| } |
| } |
| |
| } |