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.math4.legacy.analysis.solvers;
19  
20  import org.apache.commons.math4.legacy.analysis.polynomials.PolynomialFunction;
21  
22  /**
23   * Base class for solvers.
24   *
25   * @since 3.0
26   */
27  public abstract class AbstractPolynomialSolver
28      extends BaseAbstractUnivariateSolver<PolynomialFunction>
29      implements PolynomialSolver {
30      /** Function. */
31      private PolynomialFunction polynomialFunction;
32  
33      /**
34       * Construct a solver with given absolute accuracy.
35       *
36       * @param absoluteAccuracy Maximum absolute error.
37       */
38      protected AbstractPolynomialSolver(final double absoluteAccuracy) {
39          super(absoluteAccuracy);
40      }
41      /**
42       * Construct a solver with given accuracies.
43       *
44       * @param relativeAccuracy Maximum relative error.
45       * @param absoluteAccuracy Maximum absolute error.
46       */
47      protected AbstractPolynomialSolver(final double relativeAccuracy,
48                                         final double absoluteAccuracy) {
49          super(relativeAccuracy, absoluteAccuracy);
50      }
51      /**
52       * Construct a solver with given accuracies.
53       *
54       * @param relativeAccuracy Maximum relative error.
55       * @param absoluteAccuracy Maximum absolute error.
56       * @param functionValueAccuracy Maximum function value error.
57       */
58      protected AbstractPolynomialSolver(final double relativeAccuracy,
59                                         final double absoluteAccuracy,
60                                         final double functionValueAccuracy) {
61          super(relativeAccuracy, absoluteAccuracy, functionValueAccuracy);
62      }
63  
64      /**
65       * {@inheritDoc}
66       */
67      @Override
68      protected void setup(int maxEval, PolynomialFunction f,
69                               double min, double max, double startValue) {
70          super.setup(maxEval, f, min, max, startValue);
71          polynomialFunction = f;
72      }
73  
74      /**
75       * @return the coefficients of the polynomial function.
76       */
77      protected double[] getCoefficients() {
78          return polynomialFunction.getCoefficients();
79      }
80  }