View Javadoc
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    *      http://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  package org.apache.commons.math4.legacy.optim.linear;
18  
19  import org.apache.commons.math4.legacy.optim.OptimizationData;
20  
21  /**
22   * A constraint for a linear optimization problem indicating whether all
23   * variables must be restricted to non-negative values.
24   *
25   * @since 3.1
26   */
27  public class NonNegativeConstraint implements OptimizationData {
28      /** Whether the variables are all positive. */
29      private final boolean isRestricted;
30  
31      /**
32       * @param restricted If {@code true}, all the variables must be positive.
33       */
34      public NonNegativeConstraint(boolean restricted) {
35          isRestricted = restricted;
36      }
37  
38      /**
39       * Indicates whether all the variables must be restricted to non-negative
40       * values.
41       *
42       * @return {@code true} if all the variables must be positive.
43       */
44      public boolean isRestrictedToNonNegative() {
45          return isRestricted;
46      }
47  }