GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Array-C.cc
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1994-2024 The Octave Project Developers
4 //
5 // See the file COPYRIGHT.md in the top-level directory of this
6 // distribution or <https://octave.org/copyright/>.
7 //
8 // This file is part of Octave.
9 //
10 // Octave is free software: you can redistribute it and/or modify it
11 // under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // Octave is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with Octave; see the file COPYING. If not, see
22 // <https://www.gnu.org/licenses/>.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 #if defined (HAVE_CONFIG_H)
27 # include "config.h"
28 #endif
29 
30 // Instantiate Arrays of Complex values.
31 
32 #include "oct-cmplx.h"
33 #include "lo-mappers.h"
34 
35 #include "Array.h"
36 
37 // Prevent implicit instantiations on some systems (Windows, others?)
38 // that can lead to duplicate definitions of static data members.
39 
40 extern template class OCTAVE_EXTERN_TEMPLATE_API Array<octave::idx_vector>;
41 extern template class Array<octave_idx_type>;
42 
43 #include "Array-base.cc"
44 #include "oct-sort.cc"
45 
46 template <>
47 inline bool
49 {
50  return octave::math::isnan (x);
51 }
52 
53 // Sort Criteria: 1) isnan, 2) magnitude of z, 3) phase of z in range (-pi, pi]
54 
55 static bool
56 nan_ascending_compare (const Complex& x, const Complex& y)
57 {
58  return octave::math::isnan (y) ? ! octave::math::isnan (x) : x < y;
59 }
60 
61 static bool
62 nan_descending_compare (const Complex& x, const Complex& y)
63 {
64  return octave::math::isnan (x) ? ! octave::math::isnan (y) : x > y;
65 }
66 
68 safe_comparator (sortmode mode, const Array<Complex>& a, bool allow_chk)
69 {
70  Array<Complex>::compare_fcn_type result = nullptr;
71 
72  if (allow_chk)
73  {
74  octave_idx_type k = 0;
75  for (; k < a.numel () && ! octave::math::isnan (a(k)); k++) ;
76  if (k == a.numel ())
77  {
78  if (mode == ASCENDING)
80  else if (mode == DESCENDING)
82  }
83  }
84 
85  if (! result)
86  {
87  if (mode == ASCENDING)
88  result = nan_ascending_compare;
89  else if (mode == DESCENDING)
90  result = nan_descending_compare;
91  }
92 
93  return result;
94 }
95 
96 template class octave_sort<Complex>;
97 
98 INSTANTIATE_ARRAY (Complex, OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API);
99 
100 template OCTAVE_API std::ostream& operator << (std::ostream&,
101  const Array<Complex>&);
102 
103 #include "DiagArray2.h"
104 #include "DiagArray2.cc"
105 
106 template class DiagArray2<Complex>;
bool sort_isnan< Complex >(const Complex &x)
Definition: Array-C.cc:48
Array< Complex >::compare_fcn_type safe_comparator(sortmode mode, const Array< Complex > &a, bool allow_chk)
Definition: Array-C.cc:68
template std::ostream & operator<<(std::ostream &, const Array< Complex > &)
#define INSTANTIATE_ARRAY(T, API)
Definition: Array-base.cc:2782
N Dimensional Array with copy-on-write semantics.
Definition: Array.h:130
octave_idx_type numel() const
Number of elements in the array.
Definition: Array.h:414
bool isnan(bool)
Definition: lo-mappers.h:178
F77_RET_T const F77_DBLE * x
#define OCTAVE_API
Definition: main.cc:55
std::complex< double > Complex
Definition: oct-cmplx.h:33
sortmode
Definition: oct-sort.h:97
@ ASCENDING
Definition: oct-sort.h:97
@ DESCENDING
Definition: oct-sort.h:97