annotate libinterp/corefcn/pow2.cc @ 31224:45984c799215

sparse-xpow.cc: Use faster multiplication technique based on input matrix sparsity
author Arun Giridhar <arungiridhar@gmail.com>
date Sat, 10 Sep 2022 15:44:05 -0400
parents a885bdb22374
children e88a07dec498
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
1 ////////////////////////////////////////////////////////////////////////
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
2 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
3 // Copyright (C) 2022 The Octave Project Developers
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
4 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
6 // distribution or <https://octave.org/copyright/>.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
7 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
8 // This file is part of Octave.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
9 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
11 // under the terms of the GNU General Public License as published by
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
13 // (at your option) any later version.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
14 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
18 // GNU General Public License for more details.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
19 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
20 // You should have received a copy of the GNU General Public License
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
21 // along with Octave; see the file COPYING. If not, see
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
22 // <https://www.gnu.org/licenses/>.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
23 //
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
24 ////////////////////////////////////////////////////////////////////////
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
25
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
26 #if defined (HAVE_CONFIG_H)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
27 # include "config.h"
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
28 #endif
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
29
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
30 #include <cmath>
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
31
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
32 #include "lo-array-errwarn.h"
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
33
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
34 #include "defun.h"
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
35 #include "error.h"
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
36 #include "errwarn.h"
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
37
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
38 // FIXME: According to cppreference.com the implementation of `ldexp (f, e)`
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
39 // might be less efficient that the corresponding `f * exp2 (e)`. Consider
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
40 // replacing our implementation with the latter.
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
41
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
42 template <typename T>
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
43 void
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
44 map_2_xldexp (Array<T>& y, const Array<T>& f, const Array<T>& e)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
45 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
46 if (f.numel () == e.numel () || e.numel () == 1)
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
47 y = Array<T> (f.dims ());
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
48 else if (f.numel () == 1)
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
49 y = Array<T> (e.dims ());
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
50 else
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
51 octave::err_nonconformant ("pow2", f.dims (), e.dims ());
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
53 octave_idx_type f_inc = (f.numel () == 1) ? 0 : 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
54 octave_idx_type e_inc = (e.numel () == 1) ? 0 : 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
55
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
56 for (octave_idx_type i = 0; i < y.numel (); i++)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
57 y.xelem (i) = std::ldexp (f.xelem (i * f_inc),
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
58 static_cast<int> (e.xelem (i * e_inc)));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
59 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
60
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
61 void
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
62 map_2_xldexp_sparse (SparseMatrix& y, const SparseMatrix& f,
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
63 const SparseMatrix& e)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
64 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
65 if (e.numel () == 1)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
66 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
67 int ee = static_cast<int> (e.data (0));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
68 for (octave_idx_type i = 0; i < y.nnz (); i++)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
69 y.data (i) = std::ldexp (f.data (i), ee);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
70 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
71 else if (f.numel () == e.numel ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
72 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
73 octave_idx_type col = 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
74 for (octave_idx_type i = 0; i < y.nnz (); i++)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
75 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
76 // Determine current column.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
77 while (i >= f.cidx (col))
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
78 col++;
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
79 int ee = static_cast<int> (e.xelem (f.ridx (i), col - 1));
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
80 y.data (i) = std::ldexp (f.data (i), ee);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
81 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
82 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
83 else
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
84 octave::err_nonconformant ("pow2", f.dims (), e.dims ());
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
85 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
86
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
87 OCTAVE_NAMESPACE_BEGIN
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
88
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
89 DEFUN (pow2, args, ,
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
90 doc: /* -*- texinfo -*-
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
91 @deftypefn {} {@var{y} =} pow2 (@var{x})
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
92 @deftypefnx {} {@var{y} =} pow2 (@var{f}, @var{e})
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
93 With one input argument, compute
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
94 @tex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
95 $y = 2^x$
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
96 @end tex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
97 @ifnottex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
98 y = 2 .^ x
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
99 @end ifnottex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
100 for each element of @var{x}.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
101
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
102 With two input arguments, return
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
103 @tex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
104 $y = f \cdot 2^e$,
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
105 @end tex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
106 @ifnottex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
107 y = f .* (2 .^ e).
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
108 @end ifnottex
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
109 where for complex inputs only the real part of both inputs is regarded
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
110 and from @var{e} only the real integer part. This calling form corresponds
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
111 to C/C++ standard function @code{ldexp()}.
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
112 @seealso{log2, nextpow2, power}
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
113 @end deftypefn */)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
114 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
115 if (args.length () < 1 || args.length () > 2)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
116 print_usage ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
117
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
118 if (! args(0).isfloat ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
119 err_wrong_type_arg ("pow2", args(0));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
120
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
121 // Call exp2(f) where possible for numerical more accurate results.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
122 if (args.length () == 1)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
123 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
124 if (args(0).iscomplex ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
125 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
126 // The C++ standard does not define exp2 for complex arguments.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
127 // Therefore call `2.^x`.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
128 octave_value retval = octave::binary_op (octave_value::op_el_pow,
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
129 2, args(0));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
130
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
131 // Preserve sparse datatype, but even for sparse input fill-up
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
132 // is unavoidable `2^0 == 1` thus cast only.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
133 if (args(0).issparse ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
134 retval = octave_value (retval.sparse_complex_matrix_value ());
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
135
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
136 return ovl (retval);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
137 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
138 else if (args(0).is_single_type ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
139 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
140 FloatNDArray x = args(0).float_array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
141 FloatNDArray y (x.dims ());
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
142 for (octave_idx_type i = 0; i < y.numel (); i++)
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
143 y.xelem (i) = std::exp2 (x.xelem (i));
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
144 return ovl (y);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
145 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
146 else
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
147 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
148 NDArray x = args(0).array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
149 NDArray y (x.dims ());
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
150 for (octave_idx_type i = 0; i < y.numel (); i++)
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
151 y.xelem (i) = std::exp2 (x.xelem (i));
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
152
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
153 // Preserve sparse datatype, but even for sparse input fill-up
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
154 // is unavoidable `2^0 == 1` thus cast only.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
155 if (args(0).issparse ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
156 return ovl (SparseMatrix (y));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
157 else
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
158 return ovl (y);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
159 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
160 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
161
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
162 // For Matlab compatibility, the two argument call `y = pow2 (f, e)`
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
163 // corresponds to std::ldexp() (see bug #61968). The resulting y is
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
164 // computed quickly by adding the integer part of e to the floating-point
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
165 // exponent of f.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
166
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
167 if (! args(1).isfloat ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
168 err_wrong_type_arg ("pow2", args(1));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
169
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
170 if (args(0).iscomplex () || args(1).iscomplex ())
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
171 warning_with_id ("Octave:pow2:imaginary-ignored",
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
172 "pow2: imaginary part is ignored");
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
173
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
174 // Note: Matlab R2021a errors on `pow2 (sparse (f), single (e))`,
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
175 // but sparsity in f determines output and can significantly
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
176 // reduce computation, e.g. `N=1e5; pow2(speye(N),sparse(N,N))`.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
177 if (args(0).issparse ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
178 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
179 SparseMatrix f = args(0).sparse_matrix_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
180
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
181 // Special case: return a sparse zero matrix in size of e.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
182 if ((f.numel () == 1) && (f.nnz () == 0))
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
183 return ovl (SparseMatrix (args(1).rows (), args(1).columns ()));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
184
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
185 // Only do sparse computation, if it pays off. For scalar f fill-up
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
186 // is unavoidable even for sparse e because `f * 2^0 == f`. Use dense
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
187 // code below in this case.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
188 if (f.numel () > 1)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
189 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
190 SparseMatrix e = args(1).sparse_matrix_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
191 SparseMatrix y = SparseMatrix (f);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
192 map_2_xldexp_sparse (y, f, e);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
193 return ovl (y);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
194 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
195 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
196
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
197 if (args(0).is_single_type () || args(1).is_single_type ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
198 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
199 FloatNDArray f = args(0).float_array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
200 FloatNDArray e = args(1).float_array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
201 FloatNDArray y;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
202 map_2_xldexp (y, f, e);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
203 return ovl (y);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
204 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
205 else
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
206 {
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
207 NDArray f = args(0).array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
208 NDArray e = args(1).array_value ();
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
209 NDArray y;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
210 map_2_xldexp (y, f, e);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
211
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
212 // Preserve sparse datatype.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
213 // Cases for efficient use of sparsity were treated above already.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
214 if (args(0).issparse ())
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
215 return ovl (SparseMatrix (y));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
216 else
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
217 return ovl (y);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
218 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
219 }
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
220
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
221 /*
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
222 ## Call `y = pow2 (x)`
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
223
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
224 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
225 %! fcns = {@double, @single, @complex};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
226 %! x = [3, 0, -3];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
227 %! v = [8, 1, .125];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
228 %! for i = 1:numel (fcns)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
229 %! fcn = fcns{i};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
230 %! assert (pow2 (fcn (x)), fcn (v), sqrt (eps));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
231 %! endfor
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
232
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
233 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
234 %! fcns = {@double, @single, @complex, @sparse};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
235 %! x = [3, 1, -3];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
236 %! v = [8, 2, .125];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
237 %! for i = 1:numel (fcns)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
238 %! fcn = fcns{i};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
239 %! assert (pow2 (fcn (x)), fcn (v), sqrt (eps));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
240 %! endfor
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
241
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
242 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
243 %! fcns = {@double, @single, @complex, @sparse};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
244 %! x = [1, 1+1i, 1i];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
245 %! for i = 1:numel (fcns)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
246 %! fcn = fcns{i};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
247 %! assert (pow2 (fcn (x)), fcn (2) .^ fcn (x), sqrt (eps));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
248 %! endfor
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
249
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
250 ## Call `y = pow2 (f, e)`
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
251
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
252 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
253 %! fcns = {@double, @single, @complex, @sparse};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
254 %! f = [2 2];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
255 %! e = [2 2];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
256 %! z = [8 8];
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
257 %! warning ("off", "Octave:pow2:imaginary-ignored", "local");
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
258 %! for i = 1:numel (fcns)
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
259 %! fcn = fcns{i};
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
260 %! assert (pow2 (fcn (f), fcn (e)), real (fcn (z)));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
261 %! endfor
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
262
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
263 ## Only integer part is taken into account.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
264 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
265 %! f = 2;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
266 %! e = [2, 2.1, 2.2, 2.4, 2.5, 2.8];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
267 %! z = 8 .* ones (1, length (e));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
268 %! assert (pow2 (f, e), z);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
269
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
270 ## Only real part is taken into account.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
271 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
272 %! f = [1+1i, 1];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
273 %! e = 2;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
274 %! z = [4, 4];
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
275 %! warning ("off", "Octave:pow2:imaginary-ignored", "local");
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
276 %! assert (pow2 (f, e), z);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
277
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
278 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
279 %! f = 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
280 %! e = [1+1i, 1];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
281 %! z = [2, 2];
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
282 %! warning ("off", "Octave:pow2:imaginary-ignored", "local");
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
283 %! assert (pow2 (f, e), z);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
284
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
285 %!test
30717
555676697eef pow2: Minor changes (bug #61968).
Markus Mützel <markus.muetzel@gmx.de>
parents: 30716
diff changeset
286 %! f = [1/2, pi/4, -3/4, 1/2, 1-eps()/2, 1/2];
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
287 %! e = [1, 2, 2, -51, 1024, -1021];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
288 %! z = [1, pi, -3, eps(), realmax(), realmin()];
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
289 %! assert (pow2 (f, e), z);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
290
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
291 ## Tests for sparsity.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
292 %!assert (pow2 (sparse (0), ones (3)), sparse (3, 3));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
293 %!assert (pow2 (sparse (1), ones (3)), 2 .* sparse (ones (3)));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
294 %!assert (pow2 (sparse (1), speye (3)), sparse (ones (3) + eye (3)));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
295 %!assert (pow2 (sparse (3, 3), ones (3)), sparse (3, 3));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
296 %!assert (pow2 (speye (3), ones (3)), 2 .* speye (3));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
297 %!assert (pow2 (speye (3), 1), 2 .* speye (3));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
298
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
299 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
300 %! f = speye (3);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
301 %! e = sparse (3, 3);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
302 %! e(1,1) = 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
303 %! e(1,3) = 1;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
304 %! z = f;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
305 %! z(1,1) = 2;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
306 %! assert (pow2 (f, e), z);
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
307
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
308 ## Large sparse matrix (only few real elements).
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
309 %!test
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
310 %! ## FIXME: `N = 1e5` would be a better test, but `assert` fills-up somehow.
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
311 %! N = 1e3;
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
312 %! assert (pow2 (speye (N), sparse (N,N)), speye (N));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
313 %! assert (pow2 (sparse (0), speye (N)), sparse(N,N));
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
314
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
315 %!error <Invalid call> pow2 ()
30719
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
316 %!error <Invalid call> pow2 (1,2,3)
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
317 %!error <wrong type argument> pow2 (int8 (1))
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
318 %!error <wrong type argument> pow2 (2, int8 (1))
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
319 %!warning <imaginary part is ignored> pow2 (i, 2);
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
320 %!warning <imaginary part is ignored> pow2 (2, i);
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
321 %!error <pow2: nonconformant arguments> pow2 ([1,2], [3,4,5])
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2).
Rik <rik@octave.org>
parents: 30717
diff changeset
322 %!error <pow2: nonconformant arguments> pow2 (sparse ([1,2]), sparse ([3,4,5]))
30716
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
323 */
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
324
a7c4fb821d64 pow2: convert to C++ and make Matlab compatible (bug #61968).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
325 OCTAVE_NAMESPACE_END