net.bonzoun.cocodonkey: public class: RateCalculator

net.bonzoun.cocodonkey
public class: RateCalculator [javadoc | source]

java.lang.Object
   net.bonzoun.cocodonkey.RateCalculator

This class is intended to calculate a remaining time for a download. For that, it uses instant download rates and makes complicated averages on them to finally get a better approximation of the remaining time than what the instant download rate can give. A first calculation is done with a floating average of the rate on a one minute length (MINUTE_LENGTH*MINUTE_PRECISION gives the length of a minute for the calculation, the unite being the second). A second estimation uses a one hour length for the floating average (one hour is HOUR_LENGTH*HOUR_PRECISION long, the unite being the second). The best of these two calculations is supposed to be the best bet for the current rate. The addRate() method is used to add a rate. It can be called as often as possible as the current class only uses the required data (MINUTE_PRECISION determines the amount of data that will be retained).

Nested Class Summary:
class	RateCalculator.RateKeeper

Constructor:
public RateCalculator() { lastMinute = new RateKeeper(MINUTE_PRECISION, MINUTE_LENGTH); lastHour = new RateKeeper(HOUR_PRECISION, HOUR_LENGTH); }

Constructor:

 public RateCalculator() {
        lastMinute = new RateKeeper(MINUTE_PRECISION, MINUTE_LENGTH);
        lastHour = new RateKeeper(HOUR_PRECISION, HOUR_LENGTH);
}

Method from net.bonzoun.cocodonkey.RateCalculator Summary:
addRate, meanRate

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from net.bonzoun.cocodonkey.RateCalculator Detail:
public void addRate(float rate) { int nbAdded = lastMinute.addRate(rate); minuteAddedCount += nbAdded; if (minuteAddedCount >=HOUR_PRECISION/MINUTE_PRECISION) { minuteAddedCount -= HOUR_PRECISION/MINUTE_PRECISION; lastHour.addRate(lastMinute.meanRate()); } }
public float meanRate() { float minuteRate = lastMinute.meanRate(); float hourRate = lastHour.meanRate(); return Math.max(minuteRate, hourRate); }

Method from net.bonzoun.cocodonkey.RateCalculator Detail:

 public  void addRate(float rate) {
        int nbAdded = lastMinute.addRate(rate);
        minuteAddedCount += nbAdded;
        if (minuteAddedCount >=HOUR_PRECISION/MINUTE_PRECISION) {
            minuteAddedCount -= HOUR_PRECISION/MINUTE_PRECISION;
            lastHour.addRate(lastMinute.meanRate());
        }
}

 public float meanRate() {
        float minuteRate = lastMinute.meanRate();
        float hourRate = lastHour.meanRate();
        return Math.max(minuteRate, hourRate);
}