PolynomialRootFinder.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_POLYNOMIALROOTFINDER_H_
#define SimTK_SimTKCOMMON_POLYNOMIALROOTFINDER_H_

/* -------------------------------------------------------------------------- *
 *                       Simbody(tm): SimTKcommon                             *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2007-12 Stanford University and the Authors.        *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed 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/LICENSE-2.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.                                             *
 * -------------------------------------------------------------------------- */

#include "SimTKcommon/basics.h"
#include "SimTKcommon/Simmatrix.h"

namespace SimTK {

class SimTK_SimTKCOMMON_EXPORT PolynomialRootFinder {
public:
    class ZeroLeadingCoefficient;
    template <class T>
    static void findRoots(const Vec<3,T>& coefficients, Vec<2,complex<T> >& roots);
    template <class T>
    static void findRoots(const Vec<3,complex<T> >& coefficients, Vec<2,complex<T> >& roots);
    template <class T>
    static void findRoots(const Vec<4,T>& coefficients, Vec<3,complex<T> >& roots);
    template <class T>
    static void findRoots(const Vec<4,complex<T> >& coefficients, Vec<3,complex<T> >& roots);
    template <class T>
    static void findRoots(const Vector_<T>& coefficients, Vector_<complex<T> >& roots);
    template <class T>
    static void findRoots(const Vector_<complex<T> >& coefficients, Vector_<complex<T> >& roots);
};

class PolynomialRootFinder::ZeroLeadingCoefficient : public Exception::Base {
public:
    ZeroLeadingCoefficient(const char* fn, int ln) : Base(fn,ln) {
        setMessage("Attempting to find roots of a polynomial whose leading coefficient is 0.");
    }
    virtual ~ZeroLeadingCoefficient() throw() { }
};

} // namespace SimTK

#endif // SimTK_SimTKCOMMON_POLYNOMIALROOTFINDER_H_