Layout tweaks for the sumstats code, and preliminary updates for NEWS.

The layout changes are mostly whitespace and some comment rewrapping.
No functional changes.
This commit is contained in:
Robin Sommer 2013-04-28 15:34:20 -07:00
parent 1e40a2f88c
commit b9249ecf9d
21 changed files with 265 additions and 240 deletions

View file

@ -3,7 +3,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Calculate the average of the values.
AVERAGE
};
@ -33,4 +33,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
result$average = rv1$average;
else if ( rv2?$average )
result$average = rv2$average;
}
}

View file

@ -3,7 +3,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Find the maximum value.
MAX
};
@ -18,7 +18,7 @@ hook observe_hook(r: Reducer, val: double, obs: Observation, rv: ResultVal)
{
if ( MAX in r$apply )
{
if ( ! rv?$max )
if ( ! rv?$max )
rv$max = val;
else if ( val > rv$max )
rv$max = val;

View file

@ -3,7 +3,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Find the minimum value.
MIN
};
@ -18,7 +18,7 @@ hook observe_hook(r: Reducer, val: double, obs: Observation, rv: ResultVal)
{
if ( MIN in r$apply )
{
if ( ! rv?$min )
if ( ! rv?$min )
rv$min = val;
else if ( val < rv$min )
rv$min = val;
@ -33,4 +33,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
result$min = rv1$min;
else if ( rv2?$min )
result$min = rv2$min;
}
}

View file

@ -10,10 +10,8 @@ export {
};
redef record ResultVal += {
## This is the queue where samples
## are maintained. Use the
## :bro:see:`SumStats::get_samples` function
## to get a vector of the samples.
## This is the queue where samples are maintained. Use the
## :bro:see:`SumStats::get_samples` function to get a vector of the samples.
samples: Queue::Queue &optional;
};
@ -48,4 +46,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
result$samples = rv1$samples;
else if ( rv2?$samples )
result$samples = rv2$samples;
}
}

View file

@ -4,7 +4,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Find the standard deviation of the values.
STD_DEV
};

View file

@ -3,7 +3,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Sums the values given. For string values,
## this will be the number of strings given.
SUM
@ -48,4 +48,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
if ( rv2?$sum )
result$sum += rv2$sum;
}
}
}

View file

@ -3,7 +3,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Calculate the number of unique values.
UNIQUE
};
@ -16,8 +16,8 @@ export {
}
redef record ResultVal += {
# Internal use only. This is not meant to be publically available
# because we don't want to trust that we can inspect the values
# Internal use only. This is not meant to be publically available
# because we don't want to trust that we can inspect the values
# since we will like move to a probalistic data structure in the future.
# TODO: in the future this will optionally be a hyperloglog structure
unique_vals: set[Observation] &optional;
@ -27,7 +27,7 @@ hook observe_hook(r: Reducer, val: double, obs: Observation, rv: ResultVal)
{
if ( UNIQUE in r$apply )
{
if ( ! rv?$unique_vals )
if ( ! rv?$unique_vals )
rv$unique_vals=set();
add rv$unique_vals[obs];
rv$unique = |rv$unique_vals|;
@ -40,7 +40,7 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
{
if ( rv1?$unique_vals )
result$unique_vals = rv1$unique_vals;
if ( rv2?$unique_vals )
if ( ! result?$unique_vals )
result$unique_vals = rv2$unique_vals;
@ -50,4 +50,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
result$unique = |result$unique_vals|;
}
}
}

View file

@ -4,7 +4,7 @@
module SumStats;
export {
redef enum Calculation += {
redef enum Calculation += {
## Find the variance of the values.
VARIANCE
};
@ -66,4 +66,4 @@ hook compose_resultvals_hook(result: ResultVal, rv1: ResultVal, rv2: ResultVal)
result$prev_avg = rv2$prev_avg;
calc_variance(result);
}
}