org.vesalainen.math.sliding.AbstractSlidingAverage Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 tkv
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.vesalainen.math.sliding;

/**
 * Base class for sliding average calculation
 * @author tkv
 */
public abstract class AbstractSlidingAverage extends AbstractSliding
{
    /**
     * Creates an AbstractSlidingAverage
     * @param size Initial size of the ring buffer
     */
    protected AbstractSlidingAverage(int size)
    {
        super(size);
    }
    /**
     * Adds new value to sliding average
     * @param value 
     */
    @Override
    public void add(double value)
    {
        eliminate();
        int count = end-begin;
        if (count >= size)
        {
            grow();
        }
        assign(end%size, value);
        end++;
    }
            
    /**
     * Returns average without actually calculating cell by cell
     * @return 
     */
    public abstract double fast();
    /**
     * Returns average by calculating cell by cell
     * @return 
     */
    public abstract double average();

}