org.btrplace.model.constraint.RunningCapacity Maven / Gradle / Ivy

Go to download
/*
 * Copyright  2020 The BtrPlace Authors. All rights reserved.
 * Use of this source code is governed by a LGPL-style
 * license that can be found in the LICENSE.txt file.
 */

package org.btrplace.model.constraint;

import org.btrplace.model.Node;

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

/**
 * Restrict to a given value, the total amount of VMs running
 * on the given set of nodes.
 * 
 * The restriction provided by the constraint can be either discrete or continuous.
 * If it is discrete, the constraint only considers the model obtained as the end
 * of the reconfiguration process.
 * 
 * If the restriction is continuous, then the total usage must never exceed
 * the given amount, in the source model, during the reconfiguration and at the end.
 *
 * @author Fabien Hermenier
 */

@SideConstraint(args = {"ns <: nodes", "nb : int"}, inv = "sum({card(running(n)). n : ns}) <= nb")
public class RunningCapacity extends SimpleConstraint {

  private final int qty;

  private final Set nodes;

    /**
     * Make a new discrete constraint on a single node
     *
     * @param n      the node involved in the constraint
     * @param amount the maximum amount running VMs running on the given node. >= 0
     */
    public RunningCapacity(Node n, int amount) {
        this(Collections.singleton(n), amount, false);
    }

    /**
     * Make a new constraint on a single node
     *
     * @param n          the node involved in the constraint
     * @param amount     the maximum amount running VMs running on the given node. >= 0
     * @param continuous {@code true} for a continuous restriction
     */
    public RunningCapacity(Node n, int amount, boolean continuous) {
        this(Collections.singleton(n), amount, continuous);
    }

    /**
     * Make a new constraint having a discrete restriction.
     *
     * @param nodes  the nodes involved in the constraint
     * @param amount the maximum amount running VMs running on the given nodes. >= 0
     */
    public RunningCapacity(Set nodes, int amount) {
        this(nodes, amount, false);
    }

    /**
     * Make a new constraint.
     *
     * @param nodes      the nodes involved in the constraint
     * @param amount     the maximum amount running VMs running on the given nodes. >= 0
     * @param continuous {@code true} for a continuous restriction
     */
    public RunningCapacity(Set nodes, int amount, boolean continuous) {
        super(continuous);
        this.nodes = nodes;
        this.qty = amount;
        if (amount < 0) {
            throw new IllegalArgumentException("The amount of VMs must be >= 0");
        }
    }

    /**
     * Get the amount of resources
     *
     * @return a positive integer
     */
    public int getAmount() {
        return this.qty;
    }

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

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

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

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

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