NonNegativeConstraint.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      https://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. /*
  18.  * This is not the original file distributed by the Apache Software Foundation
  19.  * It has been modified by the Hipparchus project
  20.  */
  21. package org.hipparchus.optim.linear;

  22. import org.hipparchus.optim.OptimizationData;

  23. /**
  24.  * A constraint for a linear optimization problem indicating whether all
  25.  * variables must be restricted to non-negative values.
  26.  *
  27.  */
  28. public class NonNegativeConstraint implements OptimizationData {
  29.     /** Whether the variables are all positive. */
  30.     private final boolean isRestricted;

  31.     /** Simple constructor.
  32.      * @param restricted If {@code true}, all the variables must be positive.
  33.      */
  34.     public NonNegativeConstraint(boolean restricted) {
  35.         isRestricted = restricted;
  36.     }

  37.     /**
  38.      * Indicates whether all the variables must be restricted to non-negative
  39.      * values.
  40.      *
  41.      * @return {@code true} if all the variables must be positive.
  42.      */
  43.     public boolean isRestrictedToNonNegative() {
  44.         return isRestricted;
  45.     }
  46. }