Skip to content

Commit

Permalink
Fix javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
leerho committed Aug 30, 2019
1 parent 657f1aa commit 5c0cdc1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/main/java/org/apache/datasketches/hll/BaseHllSketch.java
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ public boolean isEstimationMode() {
/**
* Serializes this sketch as a byte array in compact form. The compact form is smaller in size
* than the updatable form and read-only. It can be used in union operations as follows:
* <pre>
* <pre>{@code
* Union union; HllSketch sk, sk2;
* int lgK = 12;
* sk = new HllSketch(lgK, TgtHllType.HLL_4); //can be 4, 6, or 8
Expand All @@ -218,7 +218,7 @@ public boolean isEstimationMode() {
* sk2 = HllSketch.heapify(arr);
* //OR, if used in an off-heap environment:
* sk2 = HllSketch.heapify(Memory.wrap(arr));
* </pre>
* }</pre>
*
* <p>The sketch "wrapping" operation skips actual deserialization thus is quite fast. However,
* any attempt to update the derived HllSketch will result in a Read-only exception.
Expand All @@ -231,7 +231,7 @@ public boolean isEstimationMode() {
* the compact form. The use of this form is primarily in environments that support updating
* sketches in off-heap memory. If the sketch is constructed using HLL_8, sketch updating and
* union updating operations can actually occur in WritableMemory, which can be off-heap:
* <pre>
* <pre>{@code
* Union union; HllSketch sk;
* int lgK = 12;
* sk = new HllSketch(lgK, TgtHllType.HLL_8) //must be 8
Expand All @@ -240,7 +240,7 @@ public boolean isEstimationMode() {
* WritableMemory wmem = WritableMemory.wrap(arr);
* //...
* union = Union.writableWrap(wmem); //no deserialization!
* </pre>
* }</pre>
* @return this sketch as an updatable byte array.
*/
public abstract byte[] toUpdatableByteArray();
Expand Down

0 comments on commit 5c0cdc1

Please sign in to comment.