include/opencascade/math_DirectPolynomialRoots.hxx

0001 // Created on: 1991-05-13
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _math_DirectPolynomialRoots_HeaderFile
0018 #define _math_DirectPolynomialRoots_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 #include <Standard_OStream.hxx>
0026
0027
0028 //! This class implements the calculation of all the real roots of a real
0029 //! polynomial of degree <= 4 using a direct method. Once found,
0030 //! the roots are polished using the Newton method.
0031 class math_DirectPolynomialRoots
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038
0039   //! computes all the real roots of the polynomial
0040   //! Ax4 + Bx3 + Cx2 + Dx + E using a direct method.
0041   Standard_EXPORT math_DirectPolynomialRoots(const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D, const Standard_Real E);
0042
0043
0044   //! computes all the real roots of the polynomial
0045   //! Ax3 + Bx2 + Cx + D using a direct method.
0046   Standard_EXPORT math_DirectPolynomialRoots(const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D);
0047
0048
0049   //! computes all the real roots of the polynomial
0050   //! Ax2 + Bx + C using a direct method.
0051   Standard_EXPORT math_DirectPolynomialRoots(const Standard_Real A, const Standard_Real B, const Standard_Real C);
0052
0053
0054   //! computes the real root of the polynomial Ax + B.
0055   Standard_EXPORT math_DirectPolynomialRoots(const Standard_Real A, const Standard_Real B);
0056
0057   //! Returns true if the computations are successful, otherwise returns false.
0058     Standard_Boolean IsDone() const;
0059
0060   //! Returns true if there is an infinity of roots, otherwise returns false.
0061     Standard_Boolean InfiniteRoots() const;
0062
0063   //! returns the number of solutions.
0064   //! An exception is raised if there are an infinity of roots.
0065     Standard_Integer NbSolutions() const;
0066
0067   //! returns the value of the Nieme root.
0068   //! An exception is raised if there are an infinity of roots.
0069   //! Exception RangeError is raised if Nieme is < 1
0070   //! or Nieme > NbSolutions.
0071     Standard_Real Value (const Standard_Integer Nieme) const;
0072
0073   //! Prints on the stream o information on the current state
0074   //! of the object.
0075   //! Is used to redefine the operator <<.
0076   Standard_EXPORT void Dump (Standard_OStream& o) const;
0077
0078
0079
0080
0081 protected:
0082
0083
0084   Standard_EXPORT void Solve (const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D, const Standard_Real E);
0085
0086   Standard_EXPORT void Solve (const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D);
0087
0088   Standard_EXPORT void Solve (const Standard_Real A, const Standard_Real B, const Standard_Real C);
0089
0090   Standard_EXPORT void Solve (const Standard_Real A, const Standard_Real B);
0091
0092
0093
0094
0095 private:
0096
0097
0098
0099   Standard_Boolean Done;
0100   Standard_Boolean InfiniteStatus;
0101   Standard_Integer NbSol;
0102   Standard_Real TheRoots[4];
0103
0104
0105 };
0106
0107
0108 #include <math_DirectPolynomialRoots.lxx>
0109
0110
0111
0112
0113
0114 #endif // _math_DirectPolynomialRoots_HeaderFile