tech.tablesaw.reducing.functions.SummaryFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tablesaw-core Show documentation

There is a newer version: 0.43.1

package tech.tablesaw.reducing.functions;

import tech.tablesaw.api.Table;
import tech.tablesaw.reducing.NumericReduceFunction;
import tech.tablesaw.reducing.NumericSummaryTable;
import tech.tablesaw.table.ViewGroup;

/**
 *
 */
public abstract class SummaryFunction {

    private final Table original;
    private final String summarizedColumnName;

    public SummaryFunction(Table original, String summarizedColumnName) {
        this.original = original;
        this.summarizedColumnName = summarizedColumnName;
    }

    public String summarizedColumnName() {
        return summarizedColumnName;
    }

    Table original() {
        return original;
    }

    public NumericSummaryTable by(String... columnNames) {
        ViewGroup group = ViewGroup.create(original(), columnNames);
        return group.reduce(summarizedColumnName(), function());
    }

    /**
     * Returns the result of applying to the function to all the values in the appropriate column
     */
    public double get() {
        return original.reduce(summarizedColumnName, function());
    }

    public abstract NumericReduceFunction function();
}