1/*2* Licensed to the Apache Software Foundation (ASF) under one or more3* contributor license agreements. See the NOTICE file distributed with4* this work for additional information regarding copyright ownership.5* The ASF licenses this file to You under the Apache License, Version 2.06* (the "License"); you may not use this file except in compliance with7* the License. You may obtain a copy of the License at8*9* http://www.apache.org/licenses/LICENSE-2.010*11* Unless required by applicable law or agreed to in writing, software12* 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 and15* limitations under the License.16*/17 18packageorg.apache.commons.math3.analysis.solvers; 19 20 21/** The kinds of solutions that a {@link BracketedUnivariateSolver22* (bracketed univariate real) root-finding algorithm} may accept as solutions.23* This basically controls whether or not under-approximations and24* over-approximations are allowed.25*26* <p>If all solutions are accepted ({@link #ANY_SIDE}), then the solution27* that the root-finding algorithm returns for a given root may be equal to the28* actual root, but it may also be an approximation that is slightly smaller29* or slightly larger than the actual root. Root-finding algorithms generally30* only guarantee that the returned solution is within the requested31* tolerances. In certain cases however, in particular for32* {@link org.apache.commons.math3.ode.events.EventHandler state events} of33* {@link org.apache.commons.math3.ode.ODEIntegrator ODE solvers}, it34* may be necessary to guarantee that a solution is returned that lies on a35* specific side the solution.</p>36*37* @see BracketedUnivariateSolver38* @since 3.039* @version $Id: AllowedSolution.java 1364387 2012-07-22 18:14:11Z tn $40*/41publicenum AllowedSolution { 42/** There are no additional side restriction on the solutions for43* root-finding. That is, both under-approximations and over-approximations44* are allowed. So, if a function f(x) has a root at x = x0, then the45* root-finding result s may be smaller than x0, equal to x0, or greater46* than x0.47*/48 ANY_SIDE, 49 50/** Only solutions that are less than or equal to the actual root are51* acceptable as solutions for root-finding. In other words,52* over-approximations are not allowed. So, if a function f(x) has a root53* at x = x0, then the root-finding result s must satisfy s <= x0.54*/55 LEFT_SIDE, 56 57/** Only solutions that are greater than or equal to the actual root are58* acceptable as solutions for root-finding. In other words,59* under-approximations are not allowed. So, if a function f(x) has a root60* at x = x0, then the root-finding result s must satisfy s >= x0.61*/62 RIGHT_SIDE, 63 64/** Only solutions for which values are less than or equal to zero are65* acceptable as solutions for root-finding. So, if a function f(x) has66* a root at x = x0, then the root-finding result s must satisfy f(s) <= 0.67*/68 BELOW_SIDE, 69 70/** Only solutions for which values are greater than or equal to zero are71* acceptable as solutions for root-finding. So, if a function f(x) has72* a root at x = x0, then the root-finding result s must satisfy f(s) >= 0.73*/74 ABOVE_SIDE; 75 76 }