LinearSeries.java

/*
 * Copyright 2009 VoidSearch.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.voidsearch.voidbase.quant.timeseries;

public class LinearSeries extends NumericalSequence implements SequenceGenerator {

    // intercept and slope coefficients
    // default : (y=x)
    double intercept;
    double slope;

    /**
     * default constructor
     * create simple y=x linear function generator
     */
    public LinearSeries() {
        this.intercept = 0.0;
        this.slope = 1.0;
    }

    /**
     *
     * @param intercept - intercept of linear function
     * @param slope - slope of linear function
     */
    public LinearSeries(double intercept, double slope) {
        this.intercept = intercept;
        this.slope = slope;
    }

    public void setOffset(double intercept) {
        this.intercept = intercept;
    }

    public void setSlope(double slope) {
        this.slope = slope;
    }


    public double next() {
        double value = intercept;
        value += counter*slope;
        incrementCounter();
        return value;
    }



}