src/test/java/org/apache/datasketches/theta/SketchMiscTest.java

/*
 * 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.theta;

import static org.testng.Assert.assertEquals;

import java.lang.foreign.MemorySegment;

import org.apache.datasketches.common.Family;
import org.apache.datasketches.common.SketchesArgumentException;
import org.apache.datasketches.common.Util;
import org.apache.datasketches.thetacommon.ThetaUtil;
import org.testng.annotations.Test;

/**
 * @author Lee Rhodes
 */
public class SketchMiscTest {

  private static MemorySegment getCompactSketchMemorySegment(final int k, final int from, final int to) {
    final UpdatableThetaSketch sk1 = UpdatableThetaSketch.builder().setNominalEntries(k).build();
    for (int i=from; i<to; i++) {
      sk1.update(i);
    }
    final CompactThetaSketch csk = sk1.compact(true, null);
    final byte[] sk1bytes = csk.toByteArray();
    final MemorySegment seg = MemorySegment.ofArray(sk1bytes).asReadOnly();
    return seg;
  }

  private static MemorySegment getMemorySegmentFromCompactSketch(final CompactThetaSketch csk) {
    final byte[] sk1bytes = csk.toByteArray();
    final MemorySegment seg = MemorySegment.ofArray(sk1bytes).asReadOnly();
    return seg;
  }

  private static CompactThetaSketch getCompactSketch(final int k, final int from, final int to) {
    final UpdatableThetaSketch sk1 = UpdatableThetaSketch.builder().setNominalEntries(k).build();
    for (int i=from; i<to; i++) {
      sk1.update(i);
    }
    return sk1.compact(true, null);
  }

  @Test
  public void checkSketchMethods() {
    final int k = 1024;
    final MemorySegment seg = getCompactSketchMemorySegment(k, 0, k);

    CompactThetaSketch csk2 = (CompactThetaSketch) ThetaSketch.heapify(seg);
    assertEquals((int)csk2.getEstimate(), k);

    csk2 = (CompactThetaSketch) ThetaSketch.heapify(seg, Util.DEFAULT_UPDATE_SEED);
    assertEquals((int)csk2.getEstimate(), k);

    csk2 = (CompactThetaSketch) ThetaSketch.wrap(seg);
    assertEquals((int)csk2.getEstimate(), k);

    csk2 = (CompactThetaSketch) ThetaSketch.wrap(seg, Util.DEFAULT_UPDATE_SEED);
    assertEquals((int)csk2.getEstimate(), k);
  }

  @Test
  public void checkSetOpMethods() {
    final int k = 1024;
    final MemorySegment seg1 = getCompactSketchMemorySegment(k, 0, k);
    final MemorySegment seg2 = getCompactSketchMemorySegment(k, k/2, 3*k/2);

    final ThetaSetOperationBuilder bldr = ThetaSetOperation.builder();
    final ThetaUnion union = bldr.setNominalEntries(2 * k).buildUnion();

    union.union(seg1);
    CompactThetaSketch cSk = union.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), k);
    union.union(seg2);
    cSk = union.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), 3*k/2);

    final byte[] ubytes = union.toByteArray();
    final MemorySegment uSeg = MemorySegment.ofArray(ubytes);

    ThetaUnion union2 = (ThetaUnion) ThetaSetOperation.heapify(uSeg);
    cSk = union2.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), 3*k/2);

    union2 = (ThetaUnion) ThetaSetOperation.heapify(uSeg, Util.DEFAULT_UPDATE_SEED);
    cSk = union2.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), 3*k/2);

    union2 = (ThetaUnion) ThetaSetOperation.wrap(uSeg);
    cSk = union2.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), 3*k/2);

    union2 = (ThetaUnion) ThetaSetOperation.wrap(uSeg, Util.DEFAULT_UPDATE_SEED);
    cSk = union2.getResult(true, null);
    assertEquals((int)cSk.getEstimate(), 3*k/2);

    final int serVer = ThetaSketch.getSerializationVersion(uSeg);
    assertEquals(serVer, 3);
  }

  @Test
  public void checkUtilMethods() {
    final int lgK = 10;
    final int k = 1 << lgK;

    final int maxUnionBytes = ThetaSetOperation.getMaxUnionBytes(k);
    assertEquals(2*k*8+32, maxUnionBytes);

    final int maxInterBytes = ThetaSetOperation.getMaxIntersectionBytes(k);
    assertEquals(2*k*8+24, maxInterBytes);

    final int maxCompSkBytes = ThetaSketch.getMaxCompactSketchBytes(k+1);
    assertEquals(24+(k+1)*8, maxCompSkBytes);

    final int compSkMaxBytes = ThetaSketch.getCompactSketchMaxBytes(lgK); {
        int bytes = (int)((2 << lgK) * ThetaUtil.REBUILD_THRESHOLD + Family.QUICKSELECT.getMaxPreLongs()) * Long.BYTES;
        assertEquals(compSkMaxBytes, bytes);
    }

    final int maxSkBytes = ThetaSketch.getMaxUpdateSketchBytes(k);
    assertEquals(24+2*k*8, maxSkBytes);
  }

  @Test(expectedExceptions = SketchesArgumentException.class)
  public void checkBadSketchFamily() {
    final ThetaUnion union = ThetaSetOperation.builder().buildUnion();
    final byte[] byteArr = union.toByteArray();
    final MemorySegment srcSeg = MemorySegment.ofArray(byteArr);
    ThetaSketch.getEstimate(srcSeg); //ThetaUnion is not a sketch, it is an operation
  }

  @Test
  public void printlnTest() {
    println("PRINTING: "+this.getClass().getName());
  }

  /**
   * @param s value to print
   */
  static void println(final String s) {
    //System.out.println(s); //disable here
  }

}