org.apache.ignite.ml.selection.split.TrainTestSplit Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.ignite.ml.selection.split;

import java.io.Serializable;
import org.apache.ignite.lang.IgniteBiPredicate;

/**
 * Dataset split that encapsulates train and test subsets.
 *
 * @param  Type of a key in {@code upstream} data.
 * @param  Type of a value in {@code upstream} data.
 */
public class TrainTestSplit implements Serializable {
    /** */
    private static final long serialVersionUID = 2165934349492062372L;

    /** Filter that selects train subset of the dataset. */
    private final IgniteBiPredicate trainFilter;

    /** Filter that select test subset of the dataset. */
    private final IgniteBiPredicate testFilter;

    /**
     * Constructs a new instance of train test split.
     *
     * @param trainFilter Filter that passes train subset of the dataset.
     * @param testFilter Filter that passes test subset of the dataset.
     */
    public TrainTestSplit(IgniteBiPredicate trainFilter, IgniteBiPredicate testFilter) {
        this.trainFilter = trainFilter;
        this.testFilter = testFilter;
    }

    /** */
    public IgniteBiPredicate getTrainFilter() {
        return trainFilter;
    }

    /** */
    public IgniteBiPredicate getTestFilter() {
        return testFilter;
    }
}