org.lenskit.eval.crossfold.CrossfoldMethod Maven / Gradle / Ivy

Go to download
/*
 * 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.lenskit.eval.crossfold;

import org.lenskit.data.dao.DataAccessObject;
import org.lenskit.data.entities.EntityType;

import java.io.IOException;

/**
 * The method to be used for crossfolding.
 */
public interface CrossfoldMethod {
    /**
     * Crossfold an input into some outputs.
     *
     * @param input  The input.
     * @param output The outputs.
     * @param type The type of entity to crossfold.
     */
    void crossfold(DataAccessObject input, CrossfoldOutput output, EntityType type) throws IOException;
}