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     */
017    package org.apache.commons.math3.optim.linear;
018    
019    import org.apache.commons.math3.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     * @version $Id: NonNegativeConstraint.java 1435539 2013-01-19 13:27:24Z tn $
026     * @since 3.1
027     */
028    public class NonNegativeConstraint implements OptimizationData {
029        /** Whether the variables are all positive. */
030        private final boolean isRestricted;
031    
032        /**
033         * @param restricted If {@code true}, all the variables must be positive.
034         */
035        public NonNegativeConstraint(boolean restricted) {
036            isRestricted = restricted;
037        }
038    
039        /**
040         * Indicates whether all the variables must be restricted to non-negative
041         * values.
042         *
043         * @return {@code true} if all the variables must be positive.
044         */
045        public boolean isRestrictedToNonNegative() {
046            return isRestricted;
047        }
048    }