001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math4.optim.linear;
018
019import org.apache.commons.math4.optim.OptimizationData;
020
021/**
022 * A constraint for a linear optimization problem indicating whether all
023 * variables must be restricted to non-negative values.
024 *
025 * @since 3.1
026 */
027public class NonNegativeConstraint implements OptimizationData {
028    /** Whether the variables are all positive. */
029    private final boolean isRestricted;
030
031    /**
032     * @param restricted If {@code true}, all the variables must be positive.
033     */
034    public NonNegativeConstraint(boolean restricted) {
035        isRestricted = restricted;
036    }
037
038    /**
039     * Indicates whether all the variables must be restricted to non-negative
040     * values.
041     *
042     * @return {@code true} if all the variables must be positive.
043     */
044    public boolean isRestrictedToNonNegative() {
045        return isRestricted;
046    }
047}