apache / datasketches-java / #97

Build # #97

Build Type

push

Committed by

Commit Message

<a href="https://github.com/apache/datasketches-java/commit/<a class=hub.com/apache/datasketches-java/commit/<a class="double-link" href="https://git"><a class=hub.com/apache/datasketches-java/commit/<a class="double-link" href="https://git"><a class=hub.com/apache/datasketches-java/commit/<a class="double-link" href="https://git"><a class=hub.com/apache/datasketches-java/commit/<a class="double-link" href="https://git"><a class=hub.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14">9233b951f">&lt;a href=&quot;https://github.com/apache/datasketches-java/commit/</a><a class="double-link" href="https://github.com/apache/datasketches-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/apache/datasketches-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/apache/datasketches-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/apache/datasketches-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/apache/datasketches-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14">9233b951f</a><a href="https://github.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/apache/datasketches-java/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/apache/datasketches-java/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/apache/datasketches-java/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/apache/datasketches-java/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14&quot;&gt;9233b951f&lt;/a&gt;&lt;a href=&quot;https://github.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/apache/datasketches-java/commit/9233b951f1d5b15716a9673c85c5b60ca4c8eb14&amp;quot;&amp;gt;&amp;amp;quot;&amp;amp;gt;&am... (continued)

Run Details

81 of 81 new or added lines in 3 files covered. (100.0%)

17483 of 17701 relevant lines covered (98.77%)

0.99 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.61

/src/main/java/org/apache/datasketches/tuple/CompactSketch.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.tuple;

import static org.apache.datasketches.HashOperations.count;

import java.lang.reflect.Array;
import java.nio.ByteOrder;

import org.apache.datasketches.ByteArrayUtil;
import org.apache.datasketches.Family;
import org.apache.datasketches.SketchesArgumentException;
import org.apache.datasketches.memory.Memory;

/**
 * CompactSketches are never created directly. They are created as a result of
 * the compact() method of an UpdatableSketch or as a result of the getResult()
 * method of a set operation like Union, Intersection or AnotB. CompactSketch
 * consists of a compact list (i.e. no intervening spaces) of hash values,
 * corresponding list of Summaries, and a value for theta. The lists may or may
 * not be ordered. CompactSketch is read-only.
 *
 * @param <S> type of Summary
 */
public class CompactSketch<S extends Summary> extends Sketch<S> {
  private static final byte serialVersionWithSummaryClassNameUID = 1;
  private static final byte serialVersionUID2 = 2;
  private static final byte serialVersionUID = 3;
  private static final short defaultSeedHash = (short) 37836; // for compatibility with C++
  private long[] hashArr_;
  private S[] summaryArr_;

  private enum FlagsLegacy { IS_BIG_ENDIAN, IS_EMPTY, HAS_ENTRIES, IS_THETA_INCLUDED }
  private enum Flags { IS_BIG_ENDIAN, IS_READ_ONLY, IS_EMPTY, IS_COMPACT, IS_ORDERED }

  /**
   * Create a CompactSketch from correct components
   * @param hashArr compacted hash array
   * @param summaryArr compacted summary array
   * @param thetaLong long value of theta
   * @param empty empty flag
   */
  CompactSketch(final long[] hashArr, final S[] summaryArr, final long thetaLong, final boolean empty) {
    hashArr_ = hashArr;
    summaryArr_ = summaryArr;
    thetaLong_ = thetaLong;
    empty_ = empty;
  }

  /**
   * This is to create an instance of a CompactSketch given a serialized form
   *
   * @param mem Memory object with serialized CompactSketch
   * @param deserializer the SummaryDeserializer
   */
  CompactSketch(final Memory mem, final SummaryDeserializer<S> deserializer) {
    int offset = 0;
    final byte preambleLongs = mem.getByte(offset++);
    final byte version = mem.getByte(offset++);
    final byte familyId = mem.getByte(offset++);
    SerializerDeserializer.validateFamily(familyId, preambleLongs);
    if (version > serialVersionUID) {
      throw new SketchesArgumentException(
          "Unsupported serial version. Expected: " + serialVersionUID + " or lower, actual: " + version);
    }
    SerializerDeserializer
      .validateType(mem.getByte(offset++), SerializerDeserializer.SketchType.CompactSketch);
    if (version <= serialVersionUID2) { // legacy serial format
      final byte flags = mem.getByte(offset++);
      final boolean isBigEndian = (flags & 1 << FlagsLegacy.IS_BIG_ENDIAN.ordinal()) > 0;
      if (isBigEndian ^ ByteOrder.nativeOrder().equals(ByteOrder.BIG_ENDIAN)) {
        throw new SketchesArgumentException("Byte order mismatch");
      }
      empty_ = (flags & 1 << FlagsLegacy.IS_EMPTY.ordinal()) > 0;
      final boolean isThetaIncluded = (flags & 1 << FlagsLegacy.IS_THETA_INCLUDED.ordinal()) > 0;
      if (isThetaIncluded) {
        thetaLong_ = mem.getLong(offset);
        offset += Long.BYTES;
      } else {
        thetaLong_ = Long.MAX_VALUE;
      }
      final boolean hasEntries = (flags & 1 << FlagsLegacy.HAS_ENTRIES.ordinal()) > 0;
      if (hasEntries) {
        int classNameLength = 0;
        if (version == serialVersionWithSummaryClassNameUID) {
          classNameLength = mem.getByte(offset++);
        }
        final int count = mem.getInt(offset);
        offset += Integer.BYTES;
        if (version == serialVersionWithSummaryClassNameUID) {
          offset += classNameLength;
        }
        hashArr_ = new long[count];
        for (int i = 0; i < count; i++) {
          hashArr_[i] = mem.getLong(offset);
          offset += Long.BYTES;
        }
        for (int i = 0; i < count; i++) {
          offset += readSummary(mem, offset, i, count, deserializer);
        }
      }
    } else { // current serial format
      offset++; // unused
      final byte flags = mem.getByte(offset++);
      offset += 2; // usused
      empty_ = (flags & 1 << Flags.IS_EMPTY.ordinal()) > 0;
      thetaLong_ = Long.MAX_VALUE;
      int count = 0;
      if (!empty_) {
        if (preambleLongs == 1) {
          count = 1;
        } else {
          count = mem.getInt(offset);
          offset += Integer.BYTES;
          offset += 4; // unused
          if (preambleLongs > 2) {
            thetaLong_ = mem.getLong(offset);
            offset += Long.BYTES;
          }
        }
      }
      hashArr_ = new long[count];
      for (int i = 0; i < count; i++) {
        hashArr_[i] = mem.getLong(offset);
        offset += Long.BYTES;
        offset += readSummary(mem, offset, i, count, deserializer);
      }
    }
  }

  @SuppressWarnings({"unchecked"})
  private int readSummary(final Memory mem, final int offset, final int i, final int count, final SummaryDeserializer<S> deserializer) {
    final Memory memRegion = mem.region(offset, mem.getCapacity() - offset);
    final DeserializeResult<S> result = deserializer.heapifySummary(memRegion);
    final S summary = result.getObject();
    final Class<S> summaryType = (Class<S>) result.getObject().getClass();
    if (summaryArr_ == null) {
      summaryArr_ = (S[]) Array.newInstance(summaryType, count);
    }
    summaryArr_[i] = summary;
    return result.getSize();
  }

  @Override
  public CompactSketch<S> compact() {
    return this;
  }

  long[] getHashArr() {
    return hashArr_;
  }

  S[] getSummaryArr() {
    return summaryArr_;
  }

  @Override
  public int getRetainedEntries() {
    return hashArr_ == null ? 0 : hashArr_.length;
  }

  @Override
  public int getCountLessThanThetaLong(final long thetaLong) {
    return count(hashArr_, thetaLong);
  }

  // Layout of first 8 bytes:
  // Long || Start Byte Adr:
  // Adr:
  //      ||    7   |    6   |    5   |    4   |    3   |    2   |    1   |     0              |
  //  0   ||    seed hash    |  Flags | unused | SkType | FamID  | SerVer |  Preamble_Longs    |
  @SuppressWarnings("null")
  @Override
  public byte[] toByteArray() {
        final int count = getRetainedEntries();
    final boolean isSingleItem = count == 1 && !isEstimationMode();
    final int preambleLongs = isEmpty() || isSingleItem ? 1 : isEstimationMode() ? 3 : 2;

        int summariesSizeBytes = 0;
    byte[][] summariesBytes = null;
    if (count > 0) {
      summariesBytes = new byte[count][];
      for (int i = 0; i < count; i++) {
        summariesBytes[i] = summaryArr_[i].toByteArray();
        summariesSizeBytes += summariesBytes[i].length;
      }
    }

    int sizeBytes = Long.BYTES * preambleLongs + Long.BYTES * count + summariesSizeBytes;
    final byte[] bytes = new byte[sizeBytes];
    int offset = 0;
    bytes[offset++] = (byte) preambleLongs;
    bytes[offset++] = serialVersionUID;
    bytes[offset++] = (byte) Family.TUPLE.getID();
    bytes[offset++] = (byte) SerializerDeserializer.SketchType.CompactSketch.ordinal();
    offset++; // unused
    bytes[offset++] = (byte) (
        (1 << Flags.IS_COMPACT.ordinal())
      | (1 << Flags.IS_READ_ONLY.ordinal())
      | (isEmpty() ? 1 << Flags.IS_EMPTY.ordinal() : 0)
    );
    ByteArrayUtil.putShortLE(bytes, offset, defaultSeedHash);
    offset += Short.BYTES;
    if (!isEmpty()) {
      if (!isSingleItem) {
        ByteArrayUtil.putIntLE(bytes, offset, count);
        offset += Integer.BYTES;
        offset += 4; // unused
        if (isEstimationMode()) {
              ByteArrayUtil.putLongLE(bytes, offset, thetaLong_);
              offset += Long.BYTES;
        }
      }
    }
    for (int i = 0; i < count; i++) {
      ByteArrayUtil.putLongLE(bytes, offset, hashArr_[i]);
      offset += Long.BYTES;
      System.arraycopy(summariesBytes[i], 0, bytes, offset, summariesBytes[i].length);
      offset += summariesBytes[i].length;
    }
    return bytes;
  }

  @Override
  public SketchIterator<S> iterator() {
    return new SketchIterator<>(hashArr_, summaryArr_);
  }

}

1	/*
2	* Licensed to the Apache Software Foundation (ASF) under one
3	* or more contributor license agreements. See the NOTICE file
4	* distributed with this work for additional information
5	* regarding copyright ownership. The ASF licenses this file
6	* to you under the Apache License, Version 2.0 (the
7	* "License"); you may not use this file except in compliance
8	* with the License. You may obtain a copy of the License at
9	*
10	* http://www.apache.org/licenses/LICENSE-2.0
11	*
12	* Unless required by applicable law or agreed to in writing,
13	* software distributed under the License is distributed on an
14	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15	* KIND, either express or implied. See the License for the
16	* specific language governing permissions and limitations
17	* under the License.
18	*/
19
20	package org.apache.datasketches.tuple;
21
22	import static org.apache.datasketches.HashOperations.count;
23
24	import java.lang.reflect.Array;
25	import java.nio.ByteOrder;
26
27	import org.apache.datasketches.ByteArrayUtil;
28	import org.apache.datasketches.Family;
29	import org.apache.datasketches.SketchesArgumentException;
30	import org.apache.datasketches.memory.Memory;
31
32	/**
33	* CompactSketches are never created directly. They are created as a result of
34	* the compact() method of an UpdatableSketch or as a result of the getResult()
35	* method of a set operation like Union, Intersection or AnotB. CompactSketch
36	* consists of a compact list (i.e. no intervening spaces) of hash values,
37	* corresponding list of Summaries, and a value for theta. The lists may or may
38	* not be ordered. CompactSketch is read-only.
39	*
40	* @param <S> type of Summary
41	*/
42	public class CompactSketch<S extends Summary> extends Sketch<S> {
43	private static final byte serialVersionWithSummaryClassNameUID = 1;
44	private static final byte serialVersionUID2 = 2;
45	private static final byte serialVersionUID = 3;
46	private static final short defaultSeedHash = (short) 37836; // for compatibility with C++
47	private long[] hashArr_;
48	private S[] summaryArr_;
49
50	private enum FlagsLegacy { IS_BIG_ENDIAN, IS_EMPTY, HAS_ENTRIES, IS_THETA_INCLUDED }	1✔
51	private enum Flags { IS_BIG_ENDIAN, IS_READ_ONLY, IS_EMPTY, IS_COMPACT, IS_ORDERED }	1✔
52
53	/**
54	* Create a CompactSketch from correct components
55	* @param hashArr compacted hash array
56	* @param summaryArr compacted summary array
57	* @param thetaLong long value of theta
58	* @param empty empty flag
59	*/
60	CompactSketch(final long[] hashArr, final S[] summaryArr, final long thetaLong, final boolean empty) {	1✔
61	hashArr_ = hashArr;	1✔
62	summaryArr_ = summaryArr;	1✔
63	thetaLong_ = thetaLong;	1✔
64	empty_ = empty;	1✔
65	}	1✔
66
67	/**
68	* This is to create an instance of a CompactSketch given a serialized form
69	*
70	* @param mem Memory object with serialized CompactSketch
71	* @param deserializer the SummaryDeserializer
72	*/
73	CompactSketch(final Memory mem, final SummaryDeserializer<S> deserializer) {	1✔
74	int offset = 0;	1✔
75	final byte preambleLongs = mem.getByte(offset++);	1✔
76	final byte version = mem.getByte(offset++);	1✔
77	final byte familyId = mem.getByte(offset++);	1✔
78	SerializerDeserializer.validateFamily(familyId, preambleLongs);	1✔
79	if (version > serialVersionUID) {	1✔
80	throw new SketchesArgumentException(	×
81	"Unsupported serial version. Expected: " + serialVersionUID + " or lower, actual: " + version);
82	}
83	SerializerDeserializer	1✔
84	.validateType(mem.getByte(offset++), SerializerDeserializer.SketchType.CompactSketch);	1✔
85	if (version <= serialVersionUID2) { // legacy serial format	1✔
86	final byte flags = mem.getByte(offset++);	1✔
87	final boolean isBigEndian = (flags & 1 << FlagsLegacy.IS_BIG_ENDIAN.ordinal()) > 0;	1✔
88	if (isBigEndian ^ ByteOrder.nativeOrder().equals(ByteOrder.BIG_ENDIAN)) {	1✔
89	throw new SketchesArgumentException("Byte order mismatch");	×
90	}
91	empty_ = (flags & 1 << FlagsLegacy.IS_EMPTY.ordinal()) > 0;	1✔
92	final boolean isThetaIncluded = (flags & 1 << FlagsLegacy.IS_THETA_INCLUDED.ordinal()) > 0;	1✔
93	if (isThetaIncluded) {	1✔
94	thetaLong_ = mem.getLong(offset);	1✔
95	offset += Long.BYTES;	1✔
96	} else {
97	thetaLong_ = Long.MAX_VALUE;	×
98	}
99	final boolean hasEntries = (flags & 1 << FlagsLegacy.HAS_ENTRIES.ordinal()) > 0;	1✔
100	if (hasEntries) {	1✔
101	int classNameLength = 0;	1✔
102	if (version == serialVersionWithSummaryClassNameUID) {	1✔
103	classNameLength = mem.getByte(offset++);	1✔
104	}
105	final int count = mem.getInt(offset);	1✔
106	offset += Integer.BYTES;	1✔
107	if (version == serialVersionWithSummaryClassNameUID) {	1✔
108	offset += classNameLength;	1✔
109	}
110	hashArr_ = new long[count];	1✔
111	for (int i = 0; i < count; i++) {	1✔
112	hashArr_[i] = mem.getLong(offset);	1✔
113	offset += Long.BYTES;	1✔
114	}
115	for (int i = 0; i < count; i++) {	1✔
116	offset += readSummary(mem, offset, i, count, deserializer);	1✔
117	}
118	}
119	} else { // current serial format	1✔
120	offset++; // unused	1✔
121	final byte flags = mem.getByte(offset++);	1✔
122	offset += 2; // usused	1✔
123	empty_ = (flags & 1 << Flags.IS_EMPTY.ordinal()) > 0;	1✔
124	thetaLong_ = Long.MAX_VALUE;	1✔
125	int count = 0;	1✔
126	if (!empty_) {	1✔
127	if (preambleLongs == 1) {	1✔
128	count = 1;	1✔
129	} else {
130	count = mem.getInt(offset);	1✔
131	offset += Integer.BYTES;	1✔
132	offset += 4; // unused	1✔
133	if (preambleLongs > 2) {	1✔
134	thetaLong_ = mem.getLong(offset);	1✔
135	offset += Long.BYTES;	1✔
136	}
137	}
138	}
139	hashArr_ = new long[count];	1✔
140	for (int i = 0; i < count; i++) {	1✔
141	hashArr_[i] = mem.getLong(offset);	1✔
142	offset += Long.BYTES;	1✔
143	offset += readSummary(mem, offset, i, count, deserializer);	1✔
144	}
145	}
146	}	1✔
147
148	@SuppressWarnings({"unchecked"})
149	private int readSummary(final Memory mem, final int offset, final int i, final int count, final SummaryDeserializer<S> deserializer) {
150	final Memory memRegion = mem.region(offset, mem.getCapacity() - offset);	1✔
151	final DeserializeResult<S> result = deserializer.heapifySummary(memRegion);	1✔
152	final S summary = result.getObject();	1✔
153	final Class<S> summaryType = (Class<S>) result.getObject().getClass();	1✔
154	if (summaryArr_ == null) {	1✔
155	summaryArr_ = (S[]) Array.newInstance(summaryType, count);	1✔
156	}
157	summaryArr_[i] = summary;	1✔
158	return result.getSize();	1✔
159	}
160
161	@Override
162	public CompactSketch<S> compact() {
163	return this;	1✔
164	}
165
166	long[] getHashArr() {
167	return hashArr_;	1✔
168	}
169
170	S[] getSummaryArr() {
171	return summaryArr_;	1✔
172	}
173
174	@Override
175	public int getRetainedEntries() {
176	return hashArr_ == null ? 0 : hashArr_.length;	1✔
177	}
178
179	@Override
180	public int getCountLessThanThetaLong(final long thetaLong) {
181	return count(hashArr_, thetaLong);	×
182	}
183
184	// Layout of first 8 bytes:
185	// Long \|\| Start Byte Adr:
186	// Adr:
187	// \|\| 7 \| 6 \| 5 \| 4 \| 3 \| 2 \| 1 \| 0 \|
188	// 0 \|\| seed hash \| Flags \| unused \| SkType \| FamID \| SerVer \| Preamble_Longs \|
189	@SuppressWarnings("null")
190	@Override
191	public byte[] toByteArray() {
192	final int count = getRetainedEntries();	1✔
193	final boolean isSingleItem = count == 1 && !isEstimationMode();	1✔
194	final int preambleLongs = isEmpty() \|\| isSingleItem ? 1 : isEstimationMode() ? 3 : 2;	1✔
195
196	int summariesSizeBytes = 0;	1✔
197	byte[][] summariesBytes = null;	1✔
198	if (count > 0) {	1✔
199	summariesBytes = new byte[count][];	1✔
200	for (int i = 0; i < count; i++) {	1✔
201	summariesBytes[i] = summaryArr_[i].toByteArray();	1✔
202	summariesSizeBytes += summariesBytes[i].length;	1✔
203	}
204	}
205
206	int sizeBytes = Long.BYTES * preambleLongs + Long.BYTES * count + summariesSizeBytes;	1✔
207	final byte[] bytes = new byte[sizeBytes];	1✔
208	int offset = 0;	1✔
209	bytes[offset++] = (byte) preambleLongs;	1✔
210	bytes[offset++] = serialVersionUID;	1✔
211	bytes[offset++] = (byte) Family.TUPLE.getID();	1✔
212	bytes[offset++] = (byte) SerializerDeserializer.SketchType.CompactSketch.ordinal();	1✔
213	offset++; // unused	1✔
214	bytes[offset++] = (byte) (	1✔
215	(1 << Flags.IS_COMPACT.ordinal())	1✔
216	\| (1 << Flags.IS_READ_ONLY.ordinal())	1✔
217	\| (isEmpty() ? 1 << Flags.IS_EMPTY.ordinal() : 0)	1✔
218	);
219	ByteArrayUtil.putShortLE(bytes, offset, defaultSeedHash);	1✔
220	offset += Short.BYTES;	1✔
221	if (!isEmpty()) {	1✔
222	if (!isSingleItem) {	1✔
223	ByteArrayUtil.putIntLE(bytes, offset, count);	1✔
224	offset += Integer.BYTES;	1✔
225	offset += 4; // unused	1✔
226	if (isEstimationMode()) {	1✔
227	ByteArrayUtil.putLongLE(bytes, offset, thetaLong_);	1✔
228	offset += Long.BYTES;	1✔
229	}
230	}
231	}
232	for (int i = 0; i < count; i++) {	1✔
233	ByteArrayUtil.putLongLE(bytes, offset, hashArr_[i]);	1✔
234	offset += Long.BYTES;	1✔
235	System.arraycopy(summariesBytes[i], 0, bytes, offset, summariesBytes[i].length);	1✔
236	offset += summariesBytes[i].length;	1✔
237	}
238	return bytes;	1✔
239	}
240
241	@Override
242	public SketchIterator<S> iterator() {
243	return new SketchIterator<>(hashArr_, summaryArr_);	1✔
244	}
245
246	}

apache / datasketches-java / #97

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous