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
018package org.apache.commons.math4.analysis.solvers;
019
020import org.apache.commons.math4.analysis.polynomials.PolynomialFunction;
021
022/**
023 * Base class for solvers.
024 *
025 * @since 3.0
026 */
027public abstract class AbstractPolynomialSolver
028    extends BaseAbstractUnivariateSolver<PolynomialFunction>
029    implements PolynomialSolver {
030    /** Function. */
031    private PolynomialFunction polynomialFunction;
032
033    /**
034     * Construct a solver with given absolute accuracy.
035     *
036     * @param absoluteAccuracy Maximum absolute error.
037     */
038    protected AbstractPolynomialSolver(final double absoluteAccuracy) {
039        super(absoluteAccuracy);
040    }
041    /**
042     * Construct a solver with given accuracies.
043     *
044     * @param relativeAccuracy Maximum relative error.
045     * @param absoluteAccuracy Maximum absolute error.
046     */
047    protected AbstractPolynomialSolver(final double relativeAccuracy,
048                                       final double absoluteAccuracy) {
049        super(relativeAccuracy, absoluteAccuracy);
050    }
051    /**
052     * Construct a solver with given accuracies.
053     *
054     * @param relativeAccuracy Maximum relative error.
055     * @param absoluteAccuracy Maximum absolute error.
056     * @param functionValueAccuracy Maximum function value error.
057     */
058    protected AbstractPolynomialSolver(final double relativeAccuracy,
059                                       final double absoluteAccuracy,
060                                       final double functionValueAccuracy) {
061        super(relativeAccuracy, absoluteAccuracy, functionValueAccuracy);
062    }
063
064    /**
065     * {@inheritDoc}
066     */
067    @Override
068    protected void setup(int maxEval, PolynomialFunction f,
069                             double min, double max, double startValue) {
070        super.setup(maxEval, f, min, max, startValue);
071        polynomialFunction = f;
072    }
073
074    /**
075     * @return the coefficients of the polynomial function.
076     */
077    protected double[] getCoefficients() {
078        return polynomialFunction.getCoefficients();
079    }
080}