include/opencascade/math_TrigonometricFunctionRoots.hxx

0001 // Created on: 1991-09-03
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_TrigonometricFunctionRoots_HeaderFile
0018 #define _math_TrigonometricFunctionRoots_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TColStd_Array1OfReal.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028
0029 //! This class implements the solutions of the equation
0030 //! a*Cos(x)*Cos(x) + 2*b*Cos(x)*Sin(x) + c*Cos(x) + d*Sin(x) + e
0031 //! The degree of this equation can be 4, 3 or 2.
0032 class math_TrigonometricFunctionRoots
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! Given coefficients a, b, c, d , e, this constructor
0040   //! performs the resolution of the equation above.
0041   //! The solutions must be contained in [InfBound, SupBound].
0042   //! InfBound and SupBound can be set by default to 0 and 2*PI.
0043   Standard_EXPORT math_TrigonometricFunctionRoots(const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D, const Standard_Real E, const Standard_Real InfBound, const Standard_Real SupBound);
0044
0045   //! Given the two coefficients d and e, it performs
0046   //! the resolution of d*sin(x) + e = 0.
0047   //! The solutions must be contained in [InfBound, SupBound].
0048   //! InfBound and SupBound can be set by default to 0 and 2*PI.
0049   Standard_EXPORT math_TrigonometricFunctionRoots(const Standard_Real D, const Standard_Real E, const Standard_Real InfBound, const Standard_Real SupBound);
0050
0051   //! Given the three coefficients c, d and e, it performs
0052   //! the resolution of c*Cos(x) + d*sin(x) + e = 0.
0053   //! The solutions must be contained in [InfBound, SupBound].
0054   //! InfBound and SupBound can be set by default to 0 and 2*PI.
0055   Standard_EXPORT math_TrigonometricFunctionRoots(const Standard_Real C, const Standard_Real D, const Standard_Real E, const Standard_Real InfBound, const Standard_Real SupBound);
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 solution of range Index.
0064   //! An exception is raised if NotDone.
0065   //! An exception is raised if Index>NbSolutions.
0066   //! An exception is raised if there is an infinity of solutions.
0067     Standard_Real Value (const Standard_Integer Index) const;
0068
0069   //! Returns the number of solutions found.
0070   //! An exception is raised if NotDone.
0071   //! An exception is raised if there is an infinity of solutions.
0072     Standard_Integer NbSolutions() const;
0073
0074   //! Prints information on the current state of the object.
0075   Standard_EXPORT void Dump (Standard_OStream& o) const;
0076
0077
0078
0079
0080 protected:
0081
0082
0083   //! is used by the constructors above.
0084   Standard_EXPORT void Perform (const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D, const Standard_Real E, const Standard_Real InfBound, const Standard_Real SupBound);
0085
0086
0087
0088
0089 private:
0090
0091
0092
0093   Standard_Integer NbSol;
0094   TColStd_Array1OfReal Sol;
0095   Standard_Boolean InfiniteStatus;
0096   Standard_Boolean Done;
0097
0098
0099 };
0100
0101
0102 #include <math_TrigonometricFunctionRoots.lxx>
0103
0104
0105
0106
0107
0108 #endif // _math_TrigonometricFunctionRoots_HeaderFile