org.btrplace.model.constraint.MaxOnline 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.model.constraint;

import org.btrplace.model.Node;

import java.util.Collection;
import java.util.Objects;
import java.util.Set;

/**
 * A constraint to force a set of nodes to have a maximum number of nodes to
 * be online.
 * 
 * In discrete restriction mode, the constraint only ensures that the set of
 * nodes have at most {@code n} nodes being online at by end of the reconfiguration
 * process. The set of nodes may have more number than n nodes being online in
 * the reconfiguration process.
 * 
 * In continuous restriction mode, a boot node action is performed only when the
 * number of online nodes is smaller than n.
 *
 * @author Tu Huynh Dang
 */
@SideConstraint(args = {"ns <: nodes", "nb : int"}, inv = "card({i. i : ns , nodeState(i) = online}) <= nb")
public class MaxOnline extends SimpleConstraint {

    /**
     * number of reserved nodes
     */
    private final int qty;

    private Set nodes;

    /**
     * Make a new constraint specifying restriction explicitly.
     *
     * @param nodes      The set of nodes
     * @param n          The maximum number of online nodes
     * @param continuous {@code true} for continuous restriction
     */
    public MaxOnline(Set nodes, int n, boolean continuous) {
        super(continuous);
        this.nodes = nodes;
        qty = n;
    }

    /**
     * Make a new discrete constraint.
     *
     * @param nodes the set of nodes
     * @param n     the maximum number of online nodes
     */
    public MaxOnline(Set nodes, int n) {
        this(nodes, n, false);
    }

    /**
     * Get the maximum number of online nodes.
     *
     * @return a positive integer
     */
    public int getAmount() {
        return qty;
    }


    @Override
    public String toString() {
        return "maxOnline(" + "nodes=" + nodes +
                ", amount=" + qty + ", " + (isContinuous() ? "continuous" : "discrete") + ')';
    }

    @Override
    public SatConstraintChecker getChecker() {
        return new MaxOnlineChecker(this);
    }


    @Override
    public Collection getInvolvedNodes() {
        return nodes;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        MaxOnline maxOnline = (MaxOnline) o;
        return qty == maxOnline.qty &&
                isContinuous() == maxOnline.isContinuous() &&
                Objects.equals(nodes, maxOnline.nodes);
    }

    @Override
    public int hashCode() {
        return Objects.hash(qty, nodes, isContinuous());
    }
}