Mercurial > octave
view liboctave/util/oct-cmplx.h @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 28 Dec 2021 18:22:40 -0500 |
| parents | 0a5b15007766 |
| children | 965ead41658b |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1995-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_oct_cmplx_h) #define octave_oct_cmplx_h 1 #include "octave-config.h" #include <complex> typedef std::complex<double> Complex; typedef std::complex<float> FloatComplex; // For complex-complex and complex-real comparisons, Octave uses the following // ordering: compare absolute values first; if they match, compare phase // angles. This is partially inconsistent with M*b, which compares complex // numbers only by their real parts; OTOH, it uses the same definition for // max/min and sort. The abs/arg comparison is definitely more useful (the // other one is emulated rather trivially), so let's be consistent and use that // all over. // The standard C library function arg() returns [-pi,pi], which creates a // non-unique representation for numbers along the negative real axis branch // cut. Change this to principal value (-pi,pi] by mapping -pi to pi. #if ! defined (__APPLE__) // General templated code for all (double, float) complex operators # define DEF_COMPLEXR_COMP(OP, OPS) \ template <typename T> \ inline bool operator OP (const std::complex<T>& a, \ const std::complex<T>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T ay = std::arg (a); \ OCTAVE_FLOAT_TRUNCATE const T by = std::arg (b); \ if (ay == static_cast<T> (-M_PI)) \ { \ if (by != static_cast<T> (-M_PI)) \ return static_cast<T> (M_PI) OP by; \ } \ else if (by == static_cast<T> (-M_PI)) \ { \ return ay OP static_cast<T> (M_PI); \ } \ return ay OP by; \ } \ else \ return ax OPS bx; \ } \ template <typename T> \ inline bool operator OP (const std::complex<T>& a, T b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T ay = std::arg (a); \ if (ay == static_cast<T> (-M_PI)) \ return static_cast<T> (M_PI) OP 0; \ return ay OP 0; \ } \ else \ return ax OPS bx; \ } \ template <typename T> \ inline bool operator OP (T a, const std::complex<T>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T by = std::arg (b); \ if (by == static_cast<T> (-M_PI)) \ return 0 OP static_cast<T> (M_PI); \ return 0 OP by; \ } \ else \ return ax OPS bx; \ } #else // Apple specialization. // FIXME: Apple's math library chooses to return a different value for // std::arg with floats than the constant static_cast<float> (M_PI). // Work around this obtuse behavior by providing the constant A_PI which // is Apple's definition of the constant PI for float variables. // The template code for doubles is the same as that for UNIX platforms. // Use C++ template specialization to add specific functions for float // values that make use of A_PI. // Apple version of PI # define A_PI 3.1415925025939941f # define DEF_COMPLEXR_COMP(OP, OPS) \ template <typename T> \ inline bool operator OP (const std::complex<T>& a, \ const std::complex<T>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T ay = std::arg (a); \ OCTAVE_FLOAT_TRUNCATE const T by = std::arg (b); \ if (ay == static_cast<T> (-M_PI)) \ { \ if (by != static_cast<T> (-M_PI)) \ return static_cast<T> (M_PI) OP by; \ } \ else if (by == static_cast<T> (-M_PI)) \ { \ return ay OP static_cast<T> (M_PI); \ } \ return ay OP by; \ } \ else \ return ax OPS bx; \ } \ template <typename T> \ inline bool operator OP (const std::complex<T>& a, T b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T ay = std::arg (a); \ if (ay == static_cast<T> (-M_PI)) \ return static_cast<T> (M_PI) OP 0; \ return ay OP 0; \ } \ else \ return ax OPS bx; \ } \ template <typename T> \ inline bool operator OP (T a, const std::complex<T>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const T ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const T bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const T by = std::arg (b); \ if (by == static_cast<T> (-M_PI)) \ return 0 OP static_cast<T> (M_PI); \ return 0 OP by; \ } \ else \ return ax OPS bx; \ } \ template <> \ inline bool operator OP<float> (const std::complex<float>& a, \ const std::complex<float>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const float ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const float bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const float ay = std::arg (a); \ OCTAVE_FLOAT_TRUNCATE const float by = std::arg (b); \ if (ay == -A_PI) \ { \ if (by != -A_PI) \ return static_cast<float> (M_PI) OP by; \ } \ else if (by == -A_PI) \ { \ return ay OP static_cast<float> (M_PI); \ } \ return ay OP by; \ } \ else \ return ax OPS bx; \ } \ template <> \ inline bool operator OP<float> (const std::complex<float>& a, float b) \ { \ OCTAVE_FLOAT_TRUNCATE const float ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const float bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const float ay = std::arg (a); \ if (ay == -A_PI) \ return static_cast<float> (M_PI) OP 0; \ return ay OP 0; \ } \ else \ return ax OPS bx; \ } \ template <> \ inline bool operator OP<float> (float a, const std::complex<float>& b) \ { \ OCTAVE_FLOAT_TRUNCATE const float ax = std::abs (a); \ OCTAVE_FLOAT_TRUNCATE const float bx = std::abs (b); \ if (ax == bx) \ { \ OCTAVE_FLOAT_TRUNCATE const float by = std::arg (b); \ if (by == -A_PI) \ return 0 OP static_cast<float> (M_PI); \ return 0 OP by; \ } \ else \ return ax OPS bx; \ } #endif DEF_COMPLEXR_COMP (>, >) DEF_COMPLEXR_COMP (<, <) DEF_COMPLEXR_COMP (<=, <) DEF_COMPLEXR_COMP (>=, >) #endif