/*******************************************************************************
 * Copyright (c) 2015-2019 Skymind, Inc.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License, Version 2.0 which is available at
 * https://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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ******************************************************************************/

package org.deeplearning4j.arbiter.optimize.generator.genetic.crossover;

import org.deeplearning4j.arbiter.optimize.generator.genetic.population.PopulationModel;

/**
 * Abstract class for all crossover operators
 * 
 * @author Alexandre Boulanger
 */
public abstract class CrossoverOperator {
    protected PopulationModel populationModel;

    /**
     * Will be called by the selection operator once the population model is instantiated.
     */
    public void initializeInstance(PopulationModel populationModel) {
        this.populationModel = populationModel;
    }

    /**
     * Performs the crossover
     *
     * @return The crossover result. See {@link CrossoverResult}.
     */
    public abstract CrossoverResult crossover();



}
