Rule.java

/*
 * Apache License
 * Version 2.0, January 2004
 * http://www.apache.org/licenses/
 *
 *    Copyright 2013 Aurelian Tutuianu
 *    Copyright 2014 Aurelian Tutuianu
 *    Copyright 2015 Aurelian Tutuianu
 *    Copyright 2016 Aurelian Tutuianu
 *
 *    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 rapaio.ml.classifier.rule.onerule;

import rapaio.core.tools.DVector;

import java.io.Serializable;

/**
 * Interface for a rule in one rule algorithm
 * <p>
 * Created by <a href="mailto:padreati@yahoo.com">Aurelian Tutuianu</a> on 9/14/15.
 */
public abstract class Rule implements Serializable {

    private static final long serialVersionUID = 7073304176052957223L;

    protected final int targetIndex;
    protected final DVector dv;
    protected final boolean zeroWeight;

    public Rule(int targetIndex, DVector dv) {
        this.targetIndex = targetIndex;
        this.dv = dv;
        this.zeroWeight = Math.abs(dv.sum()) < 1e-32;
    }

    public int getTargetIndex() {
        return targetIndex;
    }

    public String getTargetClass() {
        return dv.label(targetIndex);
    }

    public double getErrorCount() {
        return zeroWeight ? 0.0 : dv.sum() - dv.get(targetIndex);
    }

    public double getTotalCount() {
        return zeroWeight ? 0.0 : dv.sum();
    }

    public double getAcc() {
        return zeroWeight ? 0.0 : dv.get(targetIndex) / dv.sum();
    }

    public DVector getDV() {
        return dv;
    }
}