Relationship.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.  *      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.math3.optimization.linear;

  18. /**
  19.  * Types of relationships between two cells in a Solver {@link LinearConstraint}.
  20.  * @deprecated As of 3.1 (to be removed in 4.0).
  21.  * @since 2.0
  22.  */
  23. @Deprecated
  24. public enum Relationship {

  25.     /** Equality relationship. */
  26.     EQ("="),

  27.     /** Lesser than or equal relationship. */
  28.     LEQ("<="),

  29.     /** Greater than or equal relationship. */
  30.     GEQ(">=");

  31.     /** Display string for the relationship. */
  32.     private final String stringValue;

  33.     /** Simple constructor.
  34.      * @param stringValue display string for the relationship
  35.      */
  36.     private Relationship(String stringValue) {
  37.         this.stringValue = stringValue;
  38.     }

  39.     @Override
  40.     public String toString() {
  41.         return stringValue;
  42.     }

  43.     /**
  44.      * Get the relationship obtained when multiplying all coefficients by -1.
  45.      * @return relationship obtained when multiplying all coefficients by -1
  46.      */
  47.     public Relationship oppositeRelationship() {
  48.         switch (this) {
  49.         case LEQ :
  50.             return GEQ;
  51.         case GEQ :
  52.             return LEQ;
  53.         default :
  54.             return EQ;
  55.         }
  56.     }

  57. }