org.btrplace.scheduler.choco.MisplacedVMsEstimator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 University Nice Sophia Antipolis
 *
 * This file is part of btrplace.
 * This library 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 3 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.btrplace.scheduler.choco;

import org.btrplace.model.Instance;
import org.btrplace.model.VM;

import java.util.Set;


/**
 * An interface to specify an object that can estimated a supposed
 * set of misplaced VMs in a model.
 * 
 * This information will be used by the {@link ChocoScheduler}
 * to restrict the amount of VMs to consider in the scheduler
 * to a minimum.
 * 
 * The set of mis-placed VMs is not necessarily optimal but it must
 * be good enough to be able to compute a solution by only managing
 * these VMs.
 *
 * @author Fabien Hermenier
 */
@FunctionalInterface
public interface MisplacedVMsEstimator {


    /**
     * Get the VMs that are supposed to be mis-placed.
     *
     * @param i the instance to inspect
     * @return a set of VMs identifier that may be empty (when no VMs are misplaced)
     */
    Set getMisPlacedVMs(Instance i);
}