

Java example source code file (AllowedSolution.java)
The AllowedSolution.java Java example source code/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.math3.analysis.solvers; /** The kinds of solutions that a {@link BracketedUnivariateSolver * (bracketed univariate real) rootfinding algorithm} may accept as solutions. * This basically controls whether or not underapproximations and * overapproximations are allowed. * * <p>If all solutions are accepted ({@link #ANY_SIDE}), then the solution * that the rootfinding algorithm returns for a given root may be equal to the * actual root, but it may also be an approximation that is slightly smaller * or slightly larger than the actual root. Rootfinding algorithms generally * only guarantee that the returned solution is within the requested * tolerances. In certain cases however, in particular for * {@link org.apache.commons.math3.ode.events.EventHandler state events} of * {@link org.apache.commons.math3.ode.ODEIntegrator ODE solvers}, it * may be necessary to guarantee that a solution is returned that lies on a * specific side the solution.</p> * * @see BracketedUnivariateSolver * @since 3.0 */ public enum AllowedSolution { /** There are no additional side restriction on the solutions for * rootfinding. That is, both underapproximations and overapproximations * are allowed. So, if a function f(x) has a root at x = x0, then the * rootfinding result s may be smaller than x0, equal to x0, or greater * than x0. */ ANY_SIDE, /** Only solutions that are less than or equal to the actual root are * acceptable as solutions for rootfinding. In other words, * overapproximations are not allowed. So, if a function f(x) has a root * at x = x0, then the rootfinding result s must satisfy s <= x0. */ LEFT_SIDE, /** Only solutions that are greater than or equal to the actual root are * acceptable as solutions for rootfinding. In other words, * underapproximations are not allowed. So, if a function f(x) has a root * at x = x0, then the rootfinding result s must satisfy s >= x0. */ RIGHT_SIDE, /** Only solutions for which values are less than or equal to zero are * acceptable as solutions for rootfinding. So, if a function f(x) has * a root at x = x0, then the rootfinding result s must satisfy f(s) <= 0. */ BELOW_SIDE, /** Only solutions for which values are greater than or equal to zero are * acceptable as solutions for rootfinding. So, if a function f(x) has * a root at x = x0, then the rootfinding result s must satisfy f(s) >= 0. */ ABOVE_SIDE; } Other Java examples (source code examples)Here is a short list of links related to this Java AllowedSolution.java source code file: 
Copyright 19982021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.