| 1 |
(* ShortComplexMath.def provides access to the ShortComplex intrincics. |
| 2 |
|
| 3 |
Copyright (C) 2010-2025 Free Software Foundation, Inc. |
| 4 |
Contributed by Gaius Mulley <[email protected]>. |
| 5 |
|
| 6 |
This file is part of GNU Modula-2. |
| 7 |
|
| 8 |
GNU Modula-2 is free software; you can redistribute it and/or modify |
| 9 |
it under the terms of the GNU General Public License as published by |
| 10 |
the Free Software Foundation; either version 3, or (at your option) |
| 11 |
any later version. |
| 12 |
|
| 13 |
GNU Modula-2 is distributed in the hope that it will be useful, but |
| 14 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 16 |
General Public License for more details. |
| 17 |
|
| 18 |
Under Section 7 of GPL version 3, you are granted additional |
| 19 |
permissions described in the GCC Runtime Library Exception, version |
| 20 |
3.1, as published by the Free Software Foundation. |
| 21 |
|
| 22 |
You should have received a copy of the GNU General Public License and |
| 23 |
a copy of the GCC Runtime Library Exception along with this program; |
| 24 |
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
| 25 |
<http://www.gnu.org/licenses/>. *) |
| 26 |
|
| 27 |
DEFINITION MODULE ShortComplexMath; |
| 28 |
|
| 29 |
(* Mathematical functions for the type SHORTCOMPLEX *) |
| 30 |
|
| 31 |
CONST |
| 32 |
i = CMPLX (0.0, 1.0); |
| 33 |
one = CMPLX (1.0, 0.0); |
| 34 |
zero = CMPLX (0.0, 0.0); |
| 35 |
|
| 36 |
PROCEDURE abs (z: SHORTCOMPLEX): SHORTREAL; |
| 37 |
(* Returns the length of z *) |
| 38 |
|
| 39 |
PROCEDURE arg (z: SHORTCOMPLEX): SHORTREAL; |
| 40 |
(* Returns the angle that z subtends to the positive real axis *) |
| 41 |
|
| 42 |
PROCEDURE conj (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 43 |
(* Returns the complex conjugate of z *) |
| 44 |
|
| 45 |
PROCEDURE power (base: SHORTCOMPLEX; exponent: SHORTREAL): SHORTCOMPLEX; |
| 46 |
(* Returns the value of the number base raised to the power exponent *) |
| 47 |
|
| 48 |
PROCEDURE sqrt (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 49 |
(* Returns the principal square root of z *) |
| 50 |
|
| 51 |
PROCEDURE exp (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 52 |
(* Returns the complex exponential of z *) |
| 53 |
|
| 54 |
PROCEDURE ln (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 55 |
(* Returns the principal value of the natural logarithm of z *) |
| 56 |
|
| 57 |
PROCEDURE sin (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 58 |
(* Returns the sine of z *) |
| 59 |
|
| 60 |
PROCEDURE cos (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 61 |
(* Returns the cosine of z *) |
| 62 |
|
| 63 |
PROCEDURE tan (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 64 |
(* Returns the tangent of z *) |
| 65 |
|
| 66 |
PROCEDURE arcsin (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 67 |
(* Returns the arcsine of z *) |
| 68 |
|
| 69 |
PROCEDURE arccos (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 70 |
(* Returns the arccosine of z *) |
| 71 |
|
| 72 |
PROCEDURE arctan (z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 73 |
(* Returns the arctangent of z *) |
| 74 |
|
| 75 |
PROCEDURE polarToComplex (abs, arg: SHORTREAL): SHORTCOMPLEX; |
| 76 |
(* Returns the complex number with the specified polar coordinates *) |
| 77 |
|
| 78 |
PROCEDURE scalarMult (scalar: SHORTREAL; z: SHORTCOMPLEX): SHORTCOMPLEX; |
| 79 |
(* Returns the scalar product of scalar with z *) |
| 80 |
|
| 81 |
PROCEDURE IsCMathException (): BOOLEAN; |
| 82 |
(* Returns TRUE if the current coroutine is in the exceptional execution state |
| 83 |
because of the raising of an exception in a routine from this module; otherwise |
| 84 |
returns FALSE. |
| 85 |
*) |
| 86 |
|
| 87 |
END ShortComplexMath. |
| 88 |
|