PolynomialRootFinder.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_POLYNOMIALROOTFINDER_H_
#define SimTK_SimTKCOMMON_POLYNOMIALROOTFINDER_H_

/* -------------------------------------------------------------------------- *
 *                      SimTK Core: SimTKcommon                               *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK Core 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.               *
 *                                                                            *
 * Portions copyright (c) 2007 Stanford University and the Authors.           *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

#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_