Ensure ActionFRequency does reset if time ran backwards.

This commit is contained in:
asofold 2014-07-31 10:02:49 +02:00
parent 2f13529a29
commit 24120f306a

View File

@ -7,225 +7,238 @@ package fr.neatmonster.nocheatplus.utilities;
*
*/
public class ActionFrequency {
/** Reference time for filling in. */
private long time = 0;
/**
* Buckets to fill weights in, each represents an interval of durBucket duration,
* index 0 is the latest, highest index is the oldest.
* Weights will get filled into the next buckets with time passed.
*/
private final float[] buckets;
/** Duration in milliseconds that oe bucket covers. */
private final long durBucket;
public ActionFrequency(final int nBuckets, final long durBucket){
this.buckets = new float[nBuckets];
this.durBucket = durBucket;
}
/**
* Update and add.
* @param now
* @param amount
*/
public final void add(final long now, final float amount){
update(now);
buckets[0] += amount;
}
/**
* Unchecked addition of amount to the first bucket.
* @param amount
*/
public final void add(final float amount){
buckets[0] += amount;
}
/** Reference time for filling in. */
private long time = 0;
private long lastUpdate = 0;
/**
* Update without adding, also updates time.
* @param now
*/
public final void update(final long now) {
final long diff = now - time;
if (diff < durBucket){
// No update (first bucket).
return;
}
else if (diff >= durBucket * buckets.length || diff < 0){
// Clear (beyond range).
clear(now);
return;
}
final int shift = (int) ((float) diff / (float) durBucket);
// Update buckets.
for (int i = 0; i < buckets.length - shift; i++){
buckets[buckets.length - (i + 1)] = buckets[buckets.length - (i + 1 + shift)];
}
for (int i = 0; i < shift; i++){
buckets[i] = 0;
}
// Set time according to bucket duration (!).
time += durBucket * shift;
}
/**
* Buckets to fill weights in, each represents an interval of durBucket duration,
* index 0 is the latest, highest index is the oldest.
* Weights will get filled into the next buckets with time passed.
*/
private final float[] buckets;
public final void clear(final long now) {
for (int i = 0; i < buckets.length; i++){
buckets[i] = 0f;
}
time = now;
}
/**
* @deprecated Use instead: score(float).
* @param factor
* @return
*/
public final float getScore(final float factor){
return score(factor);
}
/**
* @deprecated Use instead: score(float).
* @param factor
* @return
*/
public final float getScore(final int bucket){
return bucketScore(bucket);
}
/**
* Get a weighted sum score, weight for bucket i: w(i) = factor^i.
* @param factor
* @return
*/
public final float score(final float factor){
return sliceScore(0, buckets.length, factor);
}
/**
* Get score of a certain bucket. At own risk.
* @param bucket
* @return
*/
public final float bucketScore(final int bucket){
return buckets[bucket];
}
/**
* Get score of first end buckets, with factor.
* @param end Number of buckets including start. The end is not included.
* @param factor
* @return
*/
public final float leadingScore(final int end, float factor){
return sliceScore(0, end, factor);
}
/**
* Get score from start on, with factor.
* @param start This is included.
* @param factor
* @return
*/
public final float trailingScore(final int start, float factor){
return sliceScore(start, buckets.length, factor);
}
/**
* Get score from start on, until before end, with factor.
* @param start This is included.
* @param end This is not included.
* @param factor
* @return
*/
public final float sliceScore(final int start, final int end, float factor){
float score = buckets[start];
float cf = factor;
for (int i = start + 1; i < end; i++){
score += buckets[i] * cf;
cf *= factor;
}
return score;
}
/**
* Set the value for a buckt.
* @param n
* @param value
*/
public final void setBucket(final int n, final float value){
buckets[n] = value;
}
/**
* Set the reference time.
* @param time
*/
public final void setTime(final long time){
this.time = time;
}
/**
* Get reference time.
* @return
*/
public final long lastAccess(){
return time;
}
/**
* Get the number of buckets.
* @return
*/
public final int numberOfBuckets(){
return buckets.length;
}
/**
* Get the duration of a bucket in milliseconds.
* @return
*/
public final long bucketDuration(){
return durBucket;
}
/**
* Serialize to a String line.
* @return
*/
public final String toLine(){
final StringBuilder buffer = new StringBuilder(50);
buffer.append(buckets.length + ","+durBucket+","+time);
for (int i = 0; i < buckets.length; i++){
buffer.append("," + buckets[i]);
}
return buffer.toString();
}
/**
* Deserialize from a string.
* @param line
* @return
*/
public static ActionFrequency fromLine(final String line){
String[] split = line.split(",");
if (split.length < 3) throw new RuntimeException("Bad argument length."); // TODO
final int n = Integer.parseInt(split[0]);
final long durBucket = Long.parseLong(split[1]);
final long time = Long.parseLong(split[2]);
final float[] buckets = new float[split.length -3];
if (split.length - 3 != buckets.length) throw new RuntimeException("Bad argument length."); // TODO
for (int i = 3; i < split.length; i ++){
buckets[i - 3] = Float.parseFloat(split[i]);
}
ActionFrequency freq = new ActionFrequency(n, durBucket);
freq.setTime(time);
for (int i = 0; i < buckets.length; i ++){
freq.setBucket(i, buckets[i]);
}
return freq;
}
/** Duration in milliseconds that oe bucket covers. */
private final long durBucket;
public ActionFrequency(final int nBuckets, final long durBucket) {
this.buckets = new float[nBuckets];
this.durBucket = durBucket;
}
/**
* Update and add.
* @param now
* @param amount
*/
public final void add(final long now, final float amount) {
update(now);
buckets[0] += amount;
}
/**
* Unchecked addition of amount to the first bucket.
* @param amount
*/
public final void add(final float amount) {
buckets[0] += amount;
}
/**
* Update without adding, also updates time. Detects time running backwards.
* @param now
*/
public final void update(final long now) {
final long diff = now - time;
if (now < lastUpdate || diff >= durBucket * buckets.length) {
// Clear (beyond range).
clear(now);
return;
}
else if (diff < durBucket) {
// No update (first bucket).
return;
}
final int shift = (int) ((float) diff / (float) durBucket);
// Update buckets.
for (int i = 0; i < buckets.length - shift; i++) {
buckets[buckets.length - (i + 1)] = buckets[buckets.length - (i + 1 + shift)];
}
for (int i = 0; i < shift; i++) {
buckets[i] = 0;
}
// Set time according to bucket duration (!).
time += durBucket * shift;
lastUpdate = now;
}
public final void clear(final long now) {
for (int i = 0; i < buckets.length; i++) {
buckets[i] = 0f;
}
time = lastUpdate = now;
}
/**
* @deprecated Use instead: score(float).
* @param factor
* @return
*/
public final float getScore(final float factor) {
return score(factor);
}
/**
* @deprecated Use instead: score(float).
* @param factor
* @return
*/
public final float getScore(final int bucket) {
return bucketScore(bucket);
}
/**
* Get a weighted sum score, weight for bucket i: w(i) = factor^i.
* @param factor
* @return
*/
public final float score(final float factor) {
return sliceScore(0, buckets.length, factor);
}
/**
* Get score of a certain bucket. At own risk.
* @param bucket
* @return
*/
public final float bucketScore(final int bucket) {
return buckets[bucket];
}
/**
* Get score of first end buckets, with factor.
* @param end Number of buckets including start. The end is not included.
* @param factor
* @return
*/
public final float leadingScore(final int end, float factor) {
return sliceScore(0, end, factor);
}
/**
* Get score from start on, with factor.
* @param start This is included.
* @param factor
* @return
*/
public final float trailingScore(final int start, float factor) {
return sliceScore(start, buckets.length, factor);
}
/**
* Get score from start on, until before end, with factor.
* @param start This is included.
* @param end This is not included.
* @param factor
* @return
*/
public final float sliceScore(final int start, final int end, float factor) {
float score = buckets[start];
float cf = factor;
for (int i = start + 1; i < end; i++) {
score += buckets[i] * cf;
cf *= factor;
}
return score;
}
/**
* Set the value for a buckt.
* @param n
* @param value
*/
public final void setBucket(final int n, final float value) {
buckets[n] = value;
}
/**
* Set the reference time.
* @param time
*/
public final void setTime(final long time) {
this.time = time;
this.lastUpdate = time;
}
/**
* Get reference time.
* @return
*/
public final long lastAccess() { // TODO: Should rename this.
return time;
}
/**
*
* @return
*/
public final long lastUpdate() {
return lastUpdate;
}
/**
* Get the number of buckets.
* @return
*/
public final int numberOfBuckets() {
return buckets.length;
}
/**
* Get the duration of a bucket in milliseconds.
* @return
*/
public final long bucketDuration() {
return durBucket;
}
/**
* Serialize to a String line.
* @return
*/
public final String toLine() {
// TODO: Backwards-compatible lastUpdate ?
final StringBuilder buffer = new StringBuilder(50);
buffer.append(buckets.length + ","+durBucket+","+time);
for (int i = 0; i < buckets.length; i++) {
buffer.append("," + buckets[i]);
}
return buffer.toString();
}
/**
* Deserialize from a string.
* @param line
* @return
*/
public static ActionFrequency fromLine(final String line) {
// TODO: Backwards-compatible lastUpdate ?
String[] split = line.split(",");
if (split.length < 3) throw new RuntimeException("Bad argument length."); // TODO
final int n = Integer.parseInt(split[0]);
final long durBucket = Long.parseLong(split[1]);
final long time = Long.parseLong(split[2]);
final float[] buckets = new float[split.length -3];
if (split.length - 3 != buckets.length) throw new RuntimeException("Bad argument length."); // TODO
for (int i = 3; i < split.length; i ++) {
buckets[i - 3] = Float.parseFloat(split[i]);
}
ActionFrequency freq = new ActionFrequency(n, durBucket);
freq.setTime(time);
for (int i = 0; i < buckets.length; i ++) {
freq.setBucket(i, buckets[i]);
}
return freq;
}
}