Files
OCCT/src/math/math_DirectPolynomialRoots.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

123 lines
3.3 KiB
Plaintext

-- Created on: 1991-05-13
-- Created by: Laurent PAINNOT
-- Copyright (c) 1991-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class DirectPolynomialRoots from math
---Purpose:
-- This class implements the calculation of all the real roots of a real
-- polynomial of degree <= 4 using a direct method. Once found,
-- the roots are polished using the Newton method.
uses OStream from Standard
raises RangeError from Standard,
InfiniteSolutions from StdFail
is
Create(A, B, C, D, E: Real)
---Purpose:
-- computes all the real roots of the polynomial
-- Ax4 + Bx3 + Cx2 + Dx + E using a direct method.
returns DirectPolynomialRoots;
Create(A, B, C, D: Real)
---Purpose:
-- computes all the real roots of the polynomial
-- Ax3 + Bx2 + Cx + D using a direct method.
returns DirectPolynomialRoots;
Create(A, B, C: Real)
---Purpose:
-- computes all the real roots of the polynomial
-- Ax2 + Bx + C using a direct method.
returns DirectPolynomialRoots;
Create(A, B: Real)
---Purpose:
-- computes the real root of the polynomial Ax + B.
returns DirectPolynomialRoots;
Solve(me: in out; A, B, C, D, E: Real)
is static protected;
Solve(me: in out; A, B, C, D: Real)
is static protected;
Solve(me: in out; A, B, C: Real)
is static protected;
Solve(me: in out; A, B: Real)
is static protected;
IsDone(me)
---Purpose: Returns true if the computations are successful, otherwise returns false.
---C++: inline
returns Boolean
is static;
InfiniteRoots(me)
---Purpose: Returns true if there is an infinity of roots, otherwise returns false.
---C++: inline
returns Boolean
is static;
NbSolutions(me)
---Purpose: returns the number of solutions.
-- An exception is raised if there are an infinity of roots.
---C++: inline
returns Integer
raises InfiniteSolutions
is static;
Value(me; Nieme: Integer)
---Purpose: returns the value of the Nieme root.
-- An exception is raised if there are an infinity of roots.
-- Exception RangeError is raised if Nieme is < 1
-- or Nieme > NbSolutions.
---C++: inline
returns Real
raises InfiniteSolutions, RangeError
is static;
Dump(me; o: in out OStream)
---Purpose: Prints on the stream o information on the current state
-- of the object.
-- Is used to redefine the operator <<.
is static;
fields
Done: Boolean;
InfiniteStatus: Boolean;
NbSol: Integer;
TheRoots: Real[4];
end DirectPolynomialRoots;