blob: 88437488be30c8b0d7aa6aba8d22ec2157530c91 [file]
/*
* 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_DOUBLES_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.KllDirectDoublesSketch;
import org.apache.datasketches.kll.KllDoublesSketch;
import org.apache.datasketches.kll.KllHeapDoublesSketch;
import org.apache.datasketches.kll.KllHelper;
import org.apache.datasketches.kll.KllPreambleUtil;
import org.apache.datasketches.quantilescommon.DoublesSortedView;
import org.apache.datasketches.quantilescommon.DoublesSortedViewIterator;
import org.testng.annotations.Test;
public class KllMiscDirectDoublesTest {
static final String LS = System.getProperty("line.separator");
@Test
public void checkBounds() {
final KllDoublesSketch kll = getDirectDoublesSketch(200, 1000);
for (int i = 0; i < 1000; i++) {
kll.update(i);
}
final double eps = kll.getNormalizedRankError(false);
final double est = kll.getQuantile(0.5);
final double ub = kll.getQuantileUpperBound(0.5);
final double 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 KllDoublesSketch sk = getDirectDoublesSketch(k, 0);
for (int i = 0; i < 10; i++) { sk.update(i + 1); }
println(sk.toString(true, true));
final KllDoublesSketch sk2 = getDirectDoublesSketch(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 KllDoublesSketch sk = getDirectDoublesSketch(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.getDoubleItemsArray()[sk.levelsArr[0]], i);
}
}
}
@Test
public void viewCompactionAndSortedView() {
final int k = 20;
final KllDoublesSketch sk = getDirectDoublesSketch(k, 0);
show(sk, 20);
final DoublesSortedView sv = sk.getSortedView();
final DoublesSortedViewIterator itr = sv.iterator();
printf("%12s%12s\n", "Value", "CumWeight");
while (itr.next()) {
final double v = itr.getQuantile();
final long wt = itr.getWeight();
printf("%12.1f%12d\n", v, wt);
}
}
private static void show(final KllDoublesSketch 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 checkSketchInitializeDoubleHeap() {
final int k = 20; //don't change this
KllDoublesSketch sk;
//println("#### CASE: DOUBLE FULL HEAP");
sk = getDirectDoublesSketch(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.getDoubleItemsArray().length, 33);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3);
assertEquals(sk.getMaxItem(), 21.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 2);
assertFalse(sk.isLevelZeroSorted());
//println("#### CASE: DOUBLE HEAP EMPTY");
sk = getDirectDoublesSketch(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.getDoubleItemsArray().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: DOUBLE HEAP SINGLE");
sk = getDirectDoublesSketch(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.getDoubleItemsArray().length, 20);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2);
assertEquals(sk.getMaxItem(), 1.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 1);
assertFalse(sk.isLevelZeroSorted());
}
@Test
public void checkSketchInitializeDoubleHeapifyCompactMemorySegment() {
final int k = 20; //don't change this
KllDoublesSketch sk;
KllDoublesSketch sk2;
byte[] compBytes;
MemorySegment wseg;
//println("#### CASE: DOUBLE FULL HEAPIFIED FROM COMPACT");
sk2 = getDirectDoublesSketch(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 = KllDoublesSketch.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.getDoubleItemsArray().length, 33);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3);
assertEquals(sk.getMaxItem(), 21.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 2);
assertFalse(sk.isLevelZeroSorted());
//println("#### CASE: DOUBLE EMPTY HEAPIFIED FROM COMPACT");
sk2 = getDirectDoublesSketch(k, 0);
//println(sk.toString(true, true));
compBytes = sk2.toByteArray();
wseg = MemorySegment.ofArray(compBytes);
//println(KllPreambleUtil.toString(wseg));
sk = KllDoublesSketch.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.getDoubleItemsArray().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: DOUBLE SINGLE HEAPIFIED FROM COMPACT");
sk2 = getDirectDoublesSketch(k, 0);
sk2.update(1);
//println(sk2.toString(true, true));
compBytes = sk2.toByteArray();
wseg = MemorySegment.ofArray(compBytes);
//println(KllPreambleUtil.toString(wseg));
sk = KllDoublesSketch.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.getDoubleItemsArray().length, 20);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2);
assertEquals(sk.getMaxItem(), 1.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 1);
assertFalse(sk.isLevelZeroSorted());
}
@Test
public void checkSketchInitializeDoubleHeapifyUpdatableMemorySegment() {
final int k = 20; //don't change this
KllDoublesSketch sk;
KllDoublesSketch sk2;
byte[] compBytes;
MemorySegment wseg;
//println("#### CASE: DOUBLE FULL HEAPIFIED FROM UPDATABLE");
sk2 = getDirectDoublesSketch(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 = KllHeapDoublesSketch.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.getDoubleItemsArray().length, 33);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 3);
assertEquals(sk.getMaxItem(), 21.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 2);
assertFalse(sk.isLevelZeroSorted());
// println("#### CASE: DOUBLE EMPTY HEAPIFIED FROM UPDATABLE");
sk2 = getDirectDoublesSketch(k, 0);
//println(sk.toString(true, true));
compBytes = KllHelper.toByteArray(sk2, true);
wseg = MemorySegment.ofArray(compBytes);
//println(KllPreambleUtil.toString(wseg));
sk = KllHeapDoublesSketch.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.getDoubleItemsArray().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: DOUBLE SINGLE HEAPIFIED FROM UPDATABLE");
sk2 = getDirectDoublesSketch(k, 0);
sk2.update(1);
//println(sk.toString(true, true));
compBytes = KllHelper.toByteArray(sk2, true);
wseg = MemorySegment.ofArray(compBytes);
//println(KllPreambleUtil.memorySegmentToString(wseg, true));
sk = KllHeapDoublesSketch.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.getDoubleItemsArray().length, 20);
assertEquals(sk.getLevelsArray(sk.sketchStructure).length, 2);
assertEquals(sk.getMaxItem(), 1.0);
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getNumLevels(), 1);
assertFalse(sk.isLevelZeroSorted());
}
@Test
public void checkMemoryToStringDoubleUpdatable() {
final int k = 20; //don't change this
KllDoublesSketch sk;
KllDoublesSketch sk2;
byte[] upBytes;
byte[] upBytes2;
MemorySegment wseg;
String s;
println("#### CASE: DOUBLE FULL UPDATABLE");
sk = getDirectDoublesSketch(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_DOUBLES_SKETCH, true);
println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment");
println(s);
sk2 = KllDoublesSketch.wrap(wseg);
upBytes2 = KllHelper.toByteArray(sk2, true);
wseg = MemorySegment.ofArray(upBytes2);
s = KllPreambleUtil.toString(wseg, KLL_DOUBLES_SKETCH, true);
println("step 2: MemorySegment to heap sketch, to byte[]/MemorySegment & analyze MemorySegment. Should match above");
println(s);
assertEquals(upBytes, upBytes2);
println("#### CASE: DOUBLE EMPTY UPDATABLE");
sk = getDirectDoublesSketch(k, 0);
upBytes = KllHelper.toByteArray(sk, true);
wseg = MemorySegment.ofArray(upBytes);
s = KllPreambleUtil.toString(wseg, KLL_DOUBLES_SKETCH, true);
println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment");
println(s);
sk2 = KllDoublesSketch.wrap(wseg);
upBytes2 = KllHelper.toByteArray(sk2, true);
wseg = MemorySegment.ofArray(upBytes2);
s = KllPreambleUtil.toString(wseg, KLL_DOUBLES_SKETCH, true);
println("step 2: MemorySegment to heap sketch, to byte[]/MemorySegment & analyze MemorySegment. Should match above");
println(s);
assertEquals(upBytes, upBytes2);
println("#### CASE: DOUBLE SINGLE UPDATABL");
sk = getDirectDoublesSketch(k, 0);
sk.update(1);
upBytes = KllHelper.toByteArray(sk, true);
wseg = MemorySegment.ofArray(upBytes);
s = KllPreambleUtil.toString(wseg, KLL_DOUBLES_SKETCH, true);
println("step 1: sketch to byte[]/MemorySegment & analyze MemorySegment");
println(s);
sk2 = KllDoublesSketch.wrap(wseg);
upBytes2 = KllHelper.toByteArray(sk2, true);
wseg = MemorySegment.ofArray(upBytes2);
s = KllPreambleUtil.toString(wseg, KLL_DOUBLES_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 KllDoublesSketch sk1 = getDirectDoublesSketch(k, 0);
final KllDoublesSketch sk2 = getDirectDoublesSketch(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(), 121.0);
assertEquals(sk1.getMinItem(), 1.0);
}
@Test
public void checkSizes() {
final KllDoublesSketch sk = getDirectDoublesSketch(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[6000]);
final KllDoublesSketch sk = KllDoublesSketch.newDirectInstance(k, dstSeg, null);
for (int i = 1; i <= 10_000; i++) {sk.update(i); }
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getMaxItem(), 10000.0);
//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 KllDoublesSketch sk = KllDirectDoublesSketch.newDirectUpdatableInstance(k, m, dstSeg, null);
for (int i = 1; i <= 200; i++) {sk.update(i); }
assertEquals(sk.getMinItem(), 1.0);
assertEquals(sk.getMaxItem(), 200.0);
}
private static KllDoublesSketch getDirectDoublesSketch(final int k, final int n) {
final KllDoublesSketch sk = KllDoublesSketch.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 KllDoublesSketch.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()); }
}
}