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    
018    package org.apache.commons.math3.optimization.linear;
019    
020    /**
021     * Types of relationships between two cells in a Solver {@link LinearConstraint}.
022     * @version $Id: Relationship.java 1422230 2012-12-15 12:11:13Z erans $
023     * @deprecated As of 3.1 (to be removed in 4.0).
024     * @since 2.0
025     */
026    @Deprecated
027    public enum Relationship {
028    
029        /** Equality relationship. */
030        EQ("="),
031    
032        /** Lesser than or equal relationship. */
033        LEQ("<="),
034    
035        /** Greater than or equal relationship. */
036        GEQ(">=");
037    
038        /** Display string for the relationship. */
039        private final String stringValue;
040    
041        /** Simple constructor.
042         * @param stringValue display string for the relationship
043         */
044        private Relationship(String stringValue) {
045            this.stringValue = stringValue;
046        }
047    
048        @Override
049        public String toString() {
050            return stringValue;
051        }
052    
053        /**
054         * Get the relationship obtained when multiplying all coefficients by -1.
055         * @return relationship obtained when multiplying all coefficients by -1
056         */
057        public Relationship oppositeRelationship() {
058            switch (this) {
059            case LEQ :
060                return GEQ;
061            case GEQ :
062                return LEQ;
063            default :
064                return EQ;
065            }
066        }
067    
068    }