Skip to content

Retain summary statistics when serializing/deserializing #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hassy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Retain summary statistics when serializing/deserializing #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions src/ddsketch/DDSketch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ interface BaseSketchConfig {
negativeStore: DenseStore;
/** The number of zeroes added to the sketch */
zeroCount: number;
min: number;
max: number;
sum: number;
}

/** Base class for DDSketch*/
Expand All @@ -45,7 +48,10 @@ class BaseDDSketch {
mapping,
store,
negativeStore,
zeroCount
zeroCount,
min = Infinity,
max = -Infinity,
sum = 0
}: BaseSketchConfig) {
this.mapping = mapping;
this.store = store;
Expand All @@ -55,9 +61,9 @@ class BaseDDSketch {

this.count =
this.negativeStore.count + this.zeroCount + this.store.count;
this.min = Infinity;
this.max = -Infinity;
this.sum = 0;
this.min = min;
this.max = max;
this.sum = sum;
}

/**
Expand Down Expand Up @@ -189,17 +195,17 @@ class BaseDDSketch {
mapping: this.mapping.toProto(),
positiveValues: this.store.toProto(),
negativeValues: this.negativeStore.toProto(),
zeroCount: this.zeroCount
zeroCount: this.zeroCount,
min: this.min,
max: this.max,
sum: this.sum
});
return ProtoDDSketch.encode(message).finish();
}

/**
* Deserialize a DDSketch from protobuf data
*
* Note: `fromProto` currently loses summary statistics for the original
* sketch (i.e. `min`, `max`)
*
* @param buffer Byte array containing DDSketch in protobuf format (from DDSketch.toProto)
*/
static fromProto(buffer: Uint8Array): DDSketch {
Expand All @@ -208,8 +214,11 @@ class BaseDDSketch {
const store = DenseStore.fromProto(decoded.positiveValues);
const negativeStore = DenseStore.fromProto(decoded.negativeValues);
const zeroCount = decoded.zeroCount;
const min = decoded.min;
const max = decoded.max;
const sum = decoded.sum;

return new BaseDDSketch({ mapping, store, negativeStore, zeroCount });
return new BaseDDSketch({ mapping, store, negativeStore, zeroCount, min, max, sum });
}
}

Expand Down Expand Up @@ -238,6 +247,6 @@ export class DDSketch extends BaseDDSketch {
const store = new DenseStore();
const negativeStore = new DenseStore();

super({ mapping, store, negativeStore, zeroCount: 0 });
super({ mapping, store, negativeStore, zeroCount: 0, min: Infinity, max: -Infinity, sum: 0 });
}
}
4 changes: 4 additions & 0 deletions src/ddsketch/proto/DDSketch.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ message DDSketch {

// The count for the value zero and its close neighborhood (whose width depends on the mapping).
double zeroCount = 4;

double min = 5;
double max = 6;
double sum = 7;
}

// How to map positive values to the bins they belong to.
Expand Down
18 changes: 18 additions & 0 deletions src/ddsketch/proto/compiled.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ export interface IDDSketch {

/** DDSketch zeroCount */
zeroCount?: (number|null);

/** DDSketch min */
min?: (number|null);

/** DDSketch max */
max?: (number|null);

/** DDSketch sum */
sum?: (number|null);
}

/** Represents a DDSketch. */
Expand All @@ -36,6 +45,15 @@ export class DDSketch implements IDDSketch {
/** DDSketch zeroCount. */
public zeroCount: number;

/** DDSketch min. */
public min: number;

/** DDSketch max. */
public max: number;

/** DDSketch sum. */
public sum: number;

/**
* Creates a new DDSketch instance using the specified properties.
* @param [properties] Properties to set
Expand Down
66 changes: 66 additions & 0 deletions src/ddsketch/proto/compiled.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ $root.DDSketch = (function() {
* @property {IStore|null} [positiveValues] DDSketch positiveValues
* @property {IStore|null} [negativeValues] DDSketch negativeValues
* @property {number|null} [zeroCount] DDSketch zeroCount
* @property {number|null} [min] DDSketch min
* @property {number|null} [max] DDSketch max
* @property {number|null} [sum] DDSketch sum
*/

/**
Expand Down Expand Up @@ -68,6 +71,30 @@ $root.DDSketch = (function() {
*/
DDSketch.prototype.zeroCount = 0;

/**
* DDSketch min.
* @member {number} min
* @memberof DDSketch
* @instance
*/
DDSketch.prototype.min = 0;

/**
* DDSketch max.
* @member {number} max
* @memberof DDSketch
* @instance
*/
DDSketch.prototype.max = 0;

/**
* DDSketch sum.
* @member {number} sum
* @memberof DDSketch
* @instance
*/
DDSketch.prototype.sum = 0;

/**
* Creates a new DDSketch instance using the specified properties.
* @function create
Expand Down Expand Up @@ -100,6 +127,12 @@ $root.DDSketch = (function() {
$root.Store.encode(message.negativeValues, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
if (message.zeroCount != null && Object.hasOwnProperty.call(message, "zeroCount"))
writer.uint32(/* id 4, wireType 1 =*/33).double(message.zeroCount);
if (message.min != null && Object.hasOwnProperty.call(message, "min"))
writer.uint32(/* id 5, wireType 1 =*/41).double(message.min);
if (message.max != null && Object.hasOwnProperty.call(message, "max"))
writer.uint32(/* id 6, wireType 1 =*/49).double(message.max);
if (message.sum != null && Object.hasOwnProperty.call(message, "sum"))
writer.uint32(/* id 7, wireType 1 =*/57).double(message.sum);
return writer;
};

Expand Down Expand Up @@ -146,6 +179,15 @@ $root.DDSketch = (function() {
case 4:
message.zeroCount = reader.double();
break;
case 5:
message.min = reader.double();
break;
case 6:
message.max = reader.double();
break;
case 7:
message.sum = reader.double();
break;
default:
reader.skipType(tag & 7);
break;
Expand Down Expand Up @@ -199,6 +241,15 @@ $root.DDSketch = (function() {
if (message.zeroCount != null && message.hasOwnProperty("zeroCount"))
if (typeof message.zeroCount !== "number")
return "zeroCount: number expected";
if (message.min != null && message.hasOwnProperty("min"))
if (typeof message.min !== "number")
return "min: number expected";
if (message.max != null && message.hasOwnProperty("max"))
if (typeof message.max !== "number")
return "max: number expected";
if (message.sum != null && message.hasOwnProperty("sum"))
if (typeof message.sum !== "number")
return "sum: number expected";
return null;
};

Expand Down Expand Up @@ -231,6 +282,12 @@ $root.DDSketch = (function() {
}
if (object.zeroCount != null)
message.zeroCount = Number(object.zeroCount);
if (object.min != null)
message.min = Number(object.min);
if (object.max != null)
message.max = Number(object.max);
if (object.sum != null)
message.sum = Number(object.sum);
return message;
};

Expand All @@ -252,6 +309,9 @@ $root.DDSketch = (function() {
object.positiveValues = null;
object.negativeValues = null;
object.zeroCount = 0;
object.min = 0;
object.max = 0;
object.sum = 0;
}
if (message.mapping != null && message.hasOwnProperty("mapping"))
object.mapping = $root.IndexMapping.toObject(message.mapping, options);
Expand All @@ -261,6 +321,12 @@ $root.DDSketch = (function() {
object.negativeValues = $root.Store.toObject(message.negativeValues, options);
if (message.zeroCount != null && message.hasOwnProperty("zeroCount"))
object.zeroCount = options.json && !isFinite(message.zeroCount) ? String(message.zeroCount) : message.zeroCount;
if (message.min != null && message.hasOwnProperty("min"))
object.min = options.json && !isFinite(message.min) ? String(message.min) : message.min;
if (message.max != null && message.hasOwnProperty("max"))
object.max = options.json && !isFinite(message.max) ? String(message.max) : message.max;
if (message.sum != null && message.hasOwnProperty("sum"))
object.sum = options.json && !isFinite(message.sum) ? String(message.sum) : message.sum;
return object;
};

Expand Down