in src/main/java/org/apache/datasketches/kll/KllPreambleUtil.java [219:406]
static <T> String toString(final Memory mem, final SketchType sketchType, final boolean includeData,
final ArrayOfItemsSerDe<T> serDe) {
if (sketchType == ITEMS_SKETCH) {
Objects.requireNonNull(serDe, "SerDe parameter must not be null for ITEMS_SKETCH.");
}
final KllMemoryValidate memVal = new KllMemoryValidate(mem, sketchType, serDe);
final SketchStructure myStructure = memVal.sketchStructure;
final int flags = memVal.flags & 0XFF;
final String flagsStr = (flags) + ", 0x" + (Integer.toHexString(flags)) + ", "
+ zeroPad(Integer.toBinaryString(flags), 8);
final int preInts = memVal.preInts; //??
final boolean emptyFlag = memVal.emptyFlag;
final int sketchBytes = memVal.sketchBytes;
final int typeBytes = sketchType.getBytes();
final int familyID = getMemoryFamilyID(mem);
final String famName = idToFamily(familyID).toString();
final StringBuilder sb = new StringBuilder();
sb.append(Util.LS).append("### KLL SKETCH MEMORY SUMMARY:").append(LS);
sb.append("Sketch Type : ").append(sketchType.toString()).append(LS);
sb.append("SketchStructure : ").append(myStructure.toString()).append(LS);
sb.append("Byte 0 : Preamble Ints : ").append(preInts).append(LS);
sb.append("Byte 1 : SerVer : ").append(memVal.serVer).append(LS);
sb.append("Byte 2 : FamilyID : ").append(memVal.familyID).append(LS);
sb.append(" : FamilyName : ").append(famName).append(LS);
sb.append("Byte 3 : Flags Field : ").append(flagsStr).append(LS);
sb.append(" Bit: Flag Name : ").append(LS);
sb.append(" 0: EMPTY : ").append(emptyFlag).append(LS);
sb.append(" 1: LEVEL_ZERO_SORTED : ").append(memVal.level0SortedFlag).append(LS);
sb.append("Bytes 4-5 : K : ").append(memVal.k).append(LS);
sb.append("Byte 6 : Min Level Cap, M : ").append(memVal.m).append(LS);
sb.append("Byte 7 : (Reserved) : ").append(LS);
final long n = memVal.n;
final int minK = memVal.minK;
final int numLevels = memVal.numLevels;
final int[] levelsArr = memVal.levelsArr; //the full levels array
final int retainedItems = levelsArr[numLevels] - levelsArr[0];
if (myStructure == COMPACT_FULL || myStructure == UPDATABLE) {
sb.append("Bytes 8-15 : N : ").append(n).append(LS);
sb.append("Bytes 16-17 : MinK : ").append(minK).append(LS);
sb.append("Byte 18 : NumLevels : ").append(numLevels).append(LS);
}
else { //COMPACT_EMPTY OR COMPACT_SINGLE
sb.append("Assumed : N : ").append(n).append(LS);
sb.append("Assumed : MinK : ").append(minK).append(LS);
sb.append("Assumed : NumLevels : ").append(numLevels).append(LS);
}
sb.append("PreambleBytes : ").append(preInts * Integer.BYTES).append(LS);
sb.append("Sketch Bytes : ").append(sketchBytes).append(LS);
sb.append("Memory Capacity Bytes : ").append(mem.getCapacity()).append(LS);
sb.append("### END KLL Sketch Memory Summary").append(LS);
if (includeData) {
sb.append(LS);
sb.append("### START KLL DATA:").append(LS);
int offsetBytes = 0;
if (myStructure == UPDATABLE) {
sb.append("LEVELS ARR:").append(LS);
offsetBytes = DATA_START_ADR;
for (int i = 0; i < numLevels + 1; i++) {
sb.append(i + ", " + mem.getInt(offsetBytes)).append(LS);
offsetBytes += Integer.BYTES;
}
sb.append("MIN/MAX:").append(LS);
if (sketchType == DOUBLES_SKETCH) {
sb.append(mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else if (sketchType == FLOATS_SKETCH) {
sb.append(mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else if (sketchType == LONGS_SKETCH) {
sb.append(mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else { //ITEMS_SKETCH
sb.append("<<<Updatable Structure is not suppported by ItemsSketch>>>").append(LS);
}
sb.append("ALL DATA (including free space)").append(LS);
final int itemsSpace = (sketchBytes - offsetBytes) / typeBytes;
if (sketchType == DOUBLES_SKETCH) {
for (int i = 0; i < itemsSpace; i++) {
sb.append(i + ", " + mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else if (sketchType == FLOATS_SKETCH) {
for (int i = 0; i < itemsSpace; i++) {
sb.append(mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else if (sketchType == LONGS_SKETCH) {
for (int i = 0; i < itemsSpace; i++) {
sb.append(mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else { //ITEMS_SKETCH
sb.append("<<<Updatable Structure is not suppported by ItemsSketch>>>").append(LS);
}
} else if (myStructure == COMPACT_FULL) {
sb.append("LEVELS ARR:").append(LS);
offsetBytes = DATA_START_ADR;
int j;
for (j = 0; j < numLevels; j++) {
sb.append(j + ", " + mem.getInt(offsetBytes)).append(LS);
offsetBytes += Integer.BYTES;
}
sb.append(j + ", " + levelsArr[numLevels]);
sb.append(" (Top level of Levels Array is absent in Memory)").append(LS);
sb.append("MIN/MAX:").append(LS);
if (sketchType == DOUBLES_SKETCH) {
sb.append(mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else if (sketchType == FLOATS_SKETCH) {
sb.append(mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else if (sketchType == LONGS_SKETCH) {
sb.append(mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
sb.append(mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
} else { //ITEMS_SKETCH
sb.append(serDe.deserializeFromMemory(mem, offsetBytes, 1)[0]).append(LS);
offsetBytes += serDe.sizeOf(mem, offsetBytes, 1);
sb.append(serDe.deserializeFromMemory(mem, offsetBytes, 1)[0]).append(LS);
offsetBytes += serDe.sizeOf(mem, offsetBytes, 1);
}
sb.append("RETAINED DATA").append(LS);
final int itemSpace = (sketchBytes - offsetBytes) / (typeBytes == 0 ? 1 : typeBytes);
if (sketchType == DOUBLES_SKETCH) {
for (int i = 0; i < itemSpace; i++) {
sb.append(i + ", " + mem.getDouble(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else if (sketchType == FLOATS_SKETCH) {
for (int i = 0; i < itemSpace; i++) {
sb.append(i + ", " + mem.getFloat(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else if (sketchType == LONGS_SKETCH) {
for (int i = 0; i < itemSpace; i++) {
sb.append(i + ", " + mem.getLong(offsetBytes)).append(LS);
offsetBytes += typeBytes;
}
} else { //ITEMS_SKETCH
final T[] itemsArr = serDe.deserializeFromMemory(mem, offsetBytes, retainedItems);
for (int i = 0; i < itemsArr.length; i++) {
sb.append(i + ", " + serDe.toString(itemsArr[i])).append(LS);
}
}
} else if (myStructure == COMPACT_SINGLE) {
sb.append("SINGLE ITEM DATUM: "); //no LS
if (sketchType == DOUBLES_SKETCH) {
sb.append(mem.getDouble(DATA_START_ADR_SINGLE_ITEM)).append(LS);
} else if (sketchType == FLOATS_SKETCH) {
sb.append(mem.getFloat(DATA_START_ADR_SINGLE_ITEM)).append(LS);
} else if (sketchType == LONGS_SKETCH) {
sb.append(mem.getLong(DATA_START_ADR_SINGLE_ITEM)).append(LS);
} else { //ITEMS_SKETCH
sb.append(serDe.deserializeFromMemory(mem, DATA_START_ADR_SINGLE_ITEM, 1)[0]).append(LS);
}
} else { //COMPACT_EMPTY
sb.append("EMPTY, NO DATA").append(LS);
}
sb.append("### END KLL DATA:").append(LS);
}
return sb.toString();
}