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  
18  package org.apache.commons.math3.analysis.solvers;
19  
20  import org.apache.commons.math3.analysis.UnivariateFunction;
21  
22  /**
23   * Base class for solvers.
24   *
25   * @since 3.0
26   * @version $Id: AbstractUnivariateSolver.java 1379560 2012-08-31 19:40:30Z erans $
27   */
28  public abstract class AbstractUnivariateSolver
29      extends BaseAbstractUnivariateSolver<UnivariateFunction>
30      implements UnivariateSolver {
31      /**
32       * Construct a solver with given absolute accuracy.
33       *
34       * @param absoluteAccuracy Maximum absolute error.
35       */
36      protected AbstractUnivariateSolver(final double absoluteAccuracy) {
37          super(absoluteAccuracy);
38      }
39      /**
40       * Construct a solver with given accuracies.
41       *
42       * @param relativeAccuracy Maximum relative error.
43       * @param absoluteAccuracy Maximum absolute error.
44       */
45      protected AbstractUnivariateSolver(final double relativeAccuracy,
46                                         final double absoluteAccuracy) {
47          super(relativeAccuracy, absoluteAccuracy);
48      }
49      /**
50       * Construct a solver with given accuracies.
51       *
52       * @param relativeAccuracy Maximum relative error.
53       * @param absoluteAccuracy Maximum absolute error.
54       * @param functionValueAccuracy Maximum function value error.
55       */
56      protected AbstractUnivariateSolver(final double relativeAccuracy,
57                                         final double absoluteAccuracy,
58                                         final double functionValueAccuracy) {
59          super(relativeAccuracy, absoluteAccuracy, functionValueAccuracy);
60      }
61  }