| /* |
| * 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.kll; |
| |
| import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_LONGS_SKETCH; |
| import static org.testng.Assert.assertEquals; |
| import static org.testng.Assert.assertFalse; |
| import static org.testng.Assert.assertTrue; |
| import static org.testng.Assert.fail; |
| |
| import java.lang.foreign.MemorySegment; |
| |
| import org.apache.datasketches.common.SketchesArgumentException; |
| import org.apache.datasketches.kll.KllDirectLongsSketch; |
| import org.apache.datasketches.kll.KllHeapLongsSketch; |
| import org.apache.datasketches.kll.KllHelper; |
| import org.apache.datasketches.kll.KllLongsSketch; |
| import org.apache.datasketches.kll.KllPreambleUtil; |
| import org.apache.datasketches.quantilescommon.LongsSortedView; |
| import org.apache.datasketches.quantilescommon.LongsSortedViewIterator; |
| import org.testng.annotations.Test; |
| |
| public class KllMiscDirectLongsTest { |
| static final String LS = System.getProperty("line.separator"); |
| |
| @Test |
| public void checkBounds() { |
| final KllLongsSketch kll = getDirectLongsSketch(200, 1000); |
| for (int i = 0; i < 1000; i++) { |
| kll.update(i); |
| } |
| final double eps = kll.getNormalizedRankError(false); |
| final long est = kll.getQuantile(0.5); |
| final long ub = kll.getQuantileUpperBound(0.5); |
| final long lb = kll.getQuantileLowerBound(0.5); |
| assertEquals(ub, kll.getQuantile(.5 + eps)); |
| assertEquals(lb, kll.getQuantile(0.5 - eps)); |
| println("Ext : " + est); |
| println("UB : " + ub); |
| println("LB : " + lb); |
| final double rest = kll.getRank(est); |
| final double restUB = kll.getRankUpperBound(rest); |
| final double restLB = kll.getRankLowerBound(rest); |
| assertTrue((restUB - rest) < (2 * eps)); |
| assertTrue((rest - restLB) < (2 * eps)); |
| } |
| |
| //@Test //enable static println(..) for visual checking |
| public void visualCheckToString() { |
| final int k = 20; |
| final KllLongsSketch sk = getDirectLongsSketch(k, 0); |
| for (int i = 0; i < 10; i++) { sk.update(i + 1); } |
| println(sk.toString(true, true)); |
| |
| final KllLongsSketch sk2 = getDirectLongsSketch(k, 0); |
| for (int i = 0; i < 400; i++) { sk2.update(i + 1); } |
| println("\n" + sk2.toString(true, true)); |
| |
| sk2.merge(sk); |
| final String s2 = sk2.toString(true, true); |
| println(LS + s2); |
| } |
| |
| @Test |
| public void viewDirectCompactions() { |
| final int k = 20; |
| final int u = 108; |
| final KllLongsSketch sk = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= u; i++) { |
| sk.update(i); |
| if (sk.levelsArr[0] == 0) { |
| println(sk.toString(true, true)); |
| sk.update(++i); |
| println(sk.toString(true, true)); |
| assertEquals(sk.getLongItemsArray()[sk.levelsArr[0]], i); |
| } |
| } |
| } |
| |
| @Test |
| public void viewCompactionAndSortedView() { |
| final int k = 20; |
| final KllLongsSketch sk = getDirectLongsSketch(k, 0); |
| show(sk, 20); |
| final LongsSortedView sv = sk.getSortedView(); |
| final LongsSortedViewIterator itr = sv.iterator(); |
| printf("%12s%12s\n", "Value", "CumWeight"); |
| while (itr.next()) { |
| final long v = itr.getQuantile(); |
| final long wt = itr.getWeight(); |
| printf("%12d%12d\n", v, wt); |
| } |
| } |
| |
| private static void show(final KllLongsSketch sk, final int limit) { |
| int i = (int) sk.getN(); |
| for ( ; i < limit; i++) { sk.update(i + 1); } |
| println(sk.toString(true, true)); |
| } |
| |
| @Test |
| public void checkSketchInitializeLongHeap() { |
| final int k = 20; //don't change this |
| KllLongsSketch sk; |
| |
| //println("#### CASE: LONG FULL HEAP"); |
| sk = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= (k + 1); i++) { sk.update(i); } |
| //println(sk.toString(true, true)); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), k + 1); |
| assertEquals(sk.getNumRetained(), 11); |
| assertFalse(sk.isEmpty()); |
| assertTrue(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 33); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3); |
| assertEquals(sk.getMaxItem(), 21L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 2); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| //println("#### CASE: LONG HEAP EMPTY"); |
| sk = getDirectLongsSketch(k, 0); |
| //println(sk.toString(true, true)); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 0); |
| assertEquals(sk.getNumRetained(), 0); |
| assertTrue(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| try { sk.getMaxItem(); fail(); } catch (final SketchesArgumentException e) { } |
| try { sk.getMinItem(); fail(); } catch (final SketchesArgumentException e) { } |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| //println("#### CASE: LONG HEAP SINGLE"); |
| sk = getDirectLongsSketch(k, 0); |
| sk.update(1); |
| //println(sk.toString(true, true)); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 1); |
| assertEquals(sk.getNumRetained(), 1); |
| assertFalse(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| assertEquals(sk.getMaxItem(), 1L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| } |
| |
| @Test |
| public void checkSketchInitializeLongHeapifyCompactMemorySegment() { |
| final int k = 20; //don't change this |
| KllLongsSketch sk; |
| KllLongsSketch sk2; |
| byte[] compBytes; |
| MemorySegment wseg; |
| |
| //println("#### CASE: LONG FULL HEAPIFIED FROM COMPACT"); |
| sk2 = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= (k + 1); i++) { sk2.update(i); } |
| //println(sk.toString(true, true)); |
| compBytes = sk2.toByteArray(); |
| wseg = MemorySegment.ofArray(compBytes); |
| //println(KllPreambleUtil.toString(wseg)); |
| sk = KllLongsSketch.heapify(wseg); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), k + 1); |
| assertEquals(sk.getNumRetained(), 11); |
| assertFalse(sk.isEmpty()); |
| assertTrue(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 33); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3); |
| assertEquals(sk.getMaxItem(), 21L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 2); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| //println("#### CASE: LONG EMPTY HEAPIFIED FROM COMPACT"); |
| sk2 = getDirectLongsSketch(k, 0); |
| //println(sk.toString(true, true)); |
| compBytes = sk2.toByteArray(); |
| wseg = MemorySegment.ofArray(compBytes); |
| //println(KllPreambleUtil.toString(wseg)); |
| sk = KllLongsSketch.heapify(wseg); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 0); |
| assertEquals(sk.getNumRetained(), 0); |
| assertTrue(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| try { sk.getMaxItem(); fail(); } catch (final SketchesArgumentException e) { } |
| try { sk.getMinItem(); fail(); } catch (final SketchesArgumentException e) { } |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| //println("#### CASE: LONG SINGLE HEAPIFIED FROM COMPACT"); |
| sk2 = getDirectLongsSketch(k, 0); |
| sk2.update(1); |
| //println(sk2.toString(true, true)); |
| compBytes = sk2.toByteArray(); |
| wseg = MemorySegment.ofArray(compBytes); |
| //println(KllPreambleUtil.toString(wseg)); |
| sk = KllLongsSketch.heapify(wseg); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 1); |
| assertEquals(sk.getNumRetained(), 1); |
| assertFalse(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| assertEquals(sk.getMaxItem(), 1L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| } |
| |
| @Test |
| public void checkSketchInitializeLongHeapifyUpdatableMemorySegment() { |
| final int k = 20; //don't change this |
| KllLongsSketch sk; |
| KllLongsSketch sk2; |
| byte[] compBytes; |
| MemorySegment wseg; |
| |
| //println("#### CASE: LONG FULL HEAPIFIED FROM UPDATABLE"); |
| sk2 = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= (k + 1); i++) { sk2.update(i); } |
| //println(sk2.toString(true, true)); |
| compBytes = KllHelper.toByteArray(sk2,true); |
| wseg = MemorySegment.ofArray(compBytes); |
| sk = KllHeapLongsSketch.heapifyImpl(wseg); |
| //println(sk.toString(true, true)); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), k + 1); |
| assertEquals(sk.getNumRetained(), 11); |
| assertFalse(sk.isEmpty()); |
| assertTrue(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 33); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3); |
| assertEquals(sk.getMaxItem(), 21L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 2); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| // println("#### CASE: LONG EMPTY HEAPIFIED FROM UPDATABLE"); |
| sk2 = getDirectLongsSketch(k, 0); |
| //println(sk.toString(true, true)); |
| compBytes = KllHelper.toByteArray(sk2, true); |
| wseg = MemorySegment.ofArray(compBytes); |
| //println(KllPreambleUtil.toString(wseg)); |
| sk = KllHeapLongsSketch.heapifyImpl(wseg); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 0); |
| assertEquals(sk.getNumRetained(), 0); |
| assertTrue(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| try { sk.getMaxItem(); fail(); } catch (final SketchesArgumentException e) { } |
| try { sk.getMinItem(); fail(); } catch (final SketchesArgumentException e) { } |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| |
| //println("#### CASE: LONG SINGLE HEAPIFIED FROM UPDATABLE"); |
| sk2 = getDirectLongsSketch(k, 0); |
| sk2.update(1); |
| //println(sk.toString(true, true)); |
| compBytes = KllHelper.toByteArray(sk2,true); |
| wseg = MemorySegment.ofArray(compBytes); |
| //println(KllPreambleUtil.toString(wseg)); |
| sk = KllHeapLongsSketch.heapifyImpl(wseg); |
| assertEquals(sk.getK(), k); |
| assertEquals(sk.getN(), 1); |
| assertEquals(sk.getNumRetained(), 1); |
| assertFalse(sk.isEmpty()); |
| assertFalse(sk.isEstimationMode()); |
| assertEquals(sk.getMinK(), k); |
| assertEquals(sk.getLongItemsArray().length, 20); |
| assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2); |
| assertEquals(sk.getMaxItem(), 1L); |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getNumLevels(), 1); |
| assertFalse(sk.isLevelZeroSorted()); |
| } |
| |
| @Test |
| public void checkMemoryToStringLongUpdatable() { |
| final int k = 20; //don't change this |
| KllLongsSketch sk; |
| KllLongsSketch sk2; |
| byte[] upBytes; |
| byte[] upBytes2; |
| MemorySegment wseg; |
| String s; |
| |
| println("#### CASE: LONG FULL UPDATABLE"); |
| sk = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= (k + 1); i++) { sk.update(i); } |
| upBytes = KllHelper.toByteArray(sk, true); |
| wseg = MemorySegment.ofArray(upBytes); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment"); |
| println(s); |
| sk2 = KllLongsSketch.wrap(wseg); |
| upBytes2 = KllHelper.toByteArray(sk2, true); |
| wseg = MemorySegment.ofArray(upBytes2); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 2: MemorySegment to heap sketch, to byte[]/MemorySegment & analyze MemorySegment. Should match above"); |
| println(s); |
| assertEquals(upBytes, upBytes2); |
| |
| println("#### CASE: LONG EMPTY UPDATABLE"); |
| sk = getDirectLongsSketch(k, 0); |
| upBytes = KllHelper.toByteArray(sk, true); |
| wseg = MemorySegment.ofArray(upBytes); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment"); |
| println(s); |
| sk2 = KllLongsSketch.wrap(wseg); |
| upBytes2 = KllHelper.toByteArray(sk2, true); |
| wseg = MemorySegment.ofArray(upBytes2); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 2: MemorySegment to heap sketch, to byte[]/MemorySegment & analyze MemorySegment. Should match above"); |
| println(s); |
| assertEquals(upBytes, upBytes2); |
| |
| println("#### CASE: LONG SINGLE UPDATABL"); |
| sk = getDirectLongsSketch(k, 0); |
| sk.update(1); |
| upBytes = KllHelper.toByteArray(sk, true); |
| wseg = MemorySegment.ofArray(upBytes); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment"); |
| println(s); |
| sk2 = KllLongsSketch.wrap(wseg); |
| upBytes2 = KllHelper.toByteArray(sk2, true); |
| wseg = MemorySegment.ofArray(upBytes2); |
| s = KllPreambleUtil.toString(wseg, KLL_LONGS_SKETCH, true); |
| println("step 2: MemorySegment to heap sketch, to byte[]/MemorySegment & analyze MemorySegment. Should match above"); |
| println(s); |
| assertEquals(upBytes, upBytes2); |
| } |
| |
| @Test |
| public void checkSimpleMerge() { |
| final int k = 20; |
| final int n1 = 21; |
| final int n2 = 21; |
| final KllLongsSketch sk1 = getDirectLongsSketch(k, 0); |
| final KllLongsSketch sk2 = getDirectLongsSketch(k, 0); |
| for (int i = 1; i <= n1; i++) { |
| sk1.update(i); |
| } |
| for (int i = 1; i <= n2; i++) { |
| sk2.update(i + 100); |
| } |
| println(sk1.toString(true, true)); |
| println(sk2.toString(true, true)); |
| sk1.merge(sk2); |
| println(sk1.toString(true, true)); |
| assertEquals(sk1.getMaxItem(), 121L); |
| assertEquals(sk1.getMinItem(), 1L); |
| } |
| |
| @Test |
| public void checkSizes() { |
| final KllLongsSketch sk = getDirectLongsSketch(20, 0); |
| for (int i = 1; i <= 21; i++) { sk.update(i); } |
| //println(sk.toString(true, true)); |
| final byte[] byteArr1 = KllHelper.toByteArray(sk, true); |
| final int size1 = sk.currentSerializedSizeBytes(true); |
| assertEquals(size1, byteArr1.length); |
| final byte[] byteArr2 = sk.toByteArray(); |
| final int size2 = sk.currentSerializedSizeBytes(false); |
| assertEquals(size2, byteArr2.length); |
| } |
| |
| @Test |
| public void checkNewInstance() { |
| final int k = 200; |
| final MemorySegment dstSeg = MemorySegment.ofArray(new byte[3000]); |
| final KllLongsSketch sk = KllLongsSketch.newDirectInstance(k, dstSeg, null); |
| for (int i = 1; i <= 10_000; i++) {sk.update(i); } |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getMaxItem(), 10000L); |
| //println(sk.toString(true, true)); |
| } |
| |
| @Test |
| public void checkDifferentM() { |
| final int k = 20; |
| final int m = 4; |
| final MemorySegment dstSeg = MemorySegment.ofArray(new byte[1000]); |
| final KllLongsSketch sk = KllDirectLongsSketch.newDirectUpdatableInstance(k, m, dstSeg, null); |
| for (int i = 1; i <= 200; i++) {sk.update(i); } |
| assertEquals(sk.getMinItem(), 1L); |
| assertEquals(sk.getMaxItem(), 200L); |
| } |
| |
| private static KllLongsSketch getDirectLongsSketch(final int k, final int n) { |
| final KllLongsSketch sk = KllLongsSketch.newHeapInstance(k); |
| for (int i = 1; i <= n; i++) { sk.update(i); } |
| final byte[] byteArr = KllHelper.toByteArray(sk, true); |
| final MemorySegment wseg = MemorySegment.ofArray(byteArr); |
| return KllLongsSketch.wrap(wseg); |
| } |
| |
| @Test |
| public void printlnTest() { |
| final String s = "PRINTING: printf in " + this.getClass().getName(); |
| println(s); |
| printf("%s\n", s); |
| } |
| |
| private final static boolean enablePrinting = false; |
| |
| /** |
| * @param format the format |
| * @param args the args |
| */ |
| private static final void printf(final String format, final Object ...args) { |
| if (enablePrinting) { System.out.printf(format, args); } |
| } |
| |
| /** |
| * @param o the Object to println |
| */ |
| private static final void println(final Object o) { |
| if (enablePrinting) { System.out.println(o.toString()); } |
| } |
| |
| } |