org.grouplens.lenskit.eval.traintest.ExperimentOutputs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lenskit-eval Show documentation

Facilities for evaluating recommender algorithms.

There is a newer version: 3.0-T5

/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2014 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 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, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.grouplens.lenskit.eval.traintest;

import org.grouplens.lenskit.eval.Attributed;
import org.grouplens.lenskit.eval.data.traintest.TTDataSet;
import org.grouplens.lenskit.eval.metrics.Metric;
import org.grouplens.lenskit.util.table.writer.TableWriter;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;

/**
 * The outputs for an experiment.
 * @author GroupLens Research
 */
class ExperimentOutputs {
    private final ExperimentOutputLayout layouts;
    @Nonnull
    private final TableWriter resultsWriter;
    @Nullable
    private final TableWriter userWriter;
    private final List> metrics;

    public ExperimentOutputs(ExperimentOutputLayout eol,
                             @Nonnull TableWriter results,
                             @Nullable TableWriter user,
                             List> ms) {
        layouts = eol;
        resultsWriter = results;
        userWriter = user;
        metrics = ms;
    }

    @Nonnull
    public TableWriter getResultsWriter() {
        return resultsWriter;
    }

    @Nullable
    public TableWriter getUserWriter() {
        return userWriter;
    }

    List> getMetrics() {
        return metrics;
    }

    public ExperimentOutputs getPrefixed(Attributed algo, TTDataSet data) {
        TableWriter results = layouts.prefixTable(resultsWriter, algo, data);
        TableWriter user = layouts.prefixTable(userWriter, algo, data);
        return new ExperimentOutputs(layouts, results, user, metrics);
    }
}