1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
########################################################################
##
## Copyright (C) 1993-2024 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/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{y} =} logspace (@var{a}, @var{b})
## @deftypefnx {} {@var{y} =} logspace (@var{a}, @var{b}, @var{n})
## @deftypefnx {} {@var{y} =} logspace (@var{a}, pi)
## @deftypefnx {} {@var{y} =} logspace (@var{a}, pi, @var{n})
## Return a row vector with @var{n} elements logarithmically spaced from
## @tex
## $10^{a}$ to $10^{b}$.
## @end tex
## @ifnottex
## 10^@var{a} to 10^@var{b}.
## @end ifnottex
##
## If the number of elements @var{n} is unspecified it defaults to 50.
##
## If @var{b} is equal to
## @tex
## $\pi$,
## @end tex
## @ifnottex
## pi,
## @end ifnottex
## the points are between
## @tex
## $10^{a}$ and $\pi$,
## @end tex
## @ifnottex
## 10^@var{a} and pi,
## @end ifnottex
## @emph{not}
## @tex
## $10^{a}$ and $10^{\pi}$,
## @end tex
## @ifnottex
## 10^@var{a} and 10^pi,
## @end ifnottex
## which is useful in digital signal processing.
##
## Programming Notes: For compatibility with @sc{matlab}, return the right-hand
## side of the range
## @tex
## ($10^{b}$)
## @end tex
## @ifnottex
## (10^@var{b})
## @end ifnottex
## when a single value (@var{n} = 1) is requested.
## If @var{n} is not an integer then @code{floor (@var{n})} is used to round
## the number of elements. If @var{n} is zero or negative then an empty 1x0
## matrix is returned.
## @seealso{linspace}
## @end deftypefn
function y = logspace (a, b, n = 50)
if (nargin < 2)
print_usage ();
endif
if (! (isscalar (a) && isscalar (b) && isscalar (n)))
error ("logspace: arguments A, B, and N must be scalars");
endif
npoints = fix (n);
if (b == pi)
b = log10 (pi);
endif
y = 10 .^ (linspace (a, b, npoints));
endfunction
%!test
%! x1 = logspace (1, 2);
%! x2 = logspace (1, 2, 10.1);
%! x3 = logspace (1, -2, 10);
%! x4 = logspace (1, pi, 10);
%! assert (size (x1) == [1, 50]);
%! assert (abs (x1(1) - 10) < eps);
%! assert (abs (x1(50) - 100) < eps);
%! assert (size (x2) == [1, 10]);
%! assert (abs (x2(1) - 10) < eps);
%! assert (abs (x2(10) - 100) < eps);
%! assert (size (x3) == [1, 10]);
%! assert (abs (x3(1) - 10) < eps);
%! assert (abs (x3(10) - 0.01) < eps);
%! assert (size (x4) == [1, 10]);
%! assert (abs (x4(1) - 10) < eps);
%! assert (abs (x4(10) - pi) < sqrt (eps));
## Edge cases
%!assert (logspace (Inf, Inf, 3), [Inf, Inf, Inf])
%!assert (logspace (-Inf, Inf, 3), [0, 1, Inf])
%!testif ; ! __have_feature__ ("LLVM_LIBCXX")
%! assert (logspace (Inf + 1i, Inf + 1i, 3),
%! repmat (complex (-Inf,Inf), [1, 3]))
%!testif HAVE_LLVM_LIBCXX <55538>
%! assert (logspace (Inf + 1i, Inf + 1i, 3),
%! repmat (complex (-Inf,Inf), [1, 3]))
%!testif ; ! __have_feature__ ("LLVM_LIBCXX")
%! assert (logspace (-Inf + 1i, Inf + 1i, 3),
%! [0, NaN + NaN * 1i, complex(-Inf, Inf)])
%!testif HAVE_LLVM_LIBCXX <55538>
%! assert (logspace (-Inf + 1i, Inf + 1i, 3),
%! [0, NaN + NaN * 1i, complex(-Inf, Inf)])
## Octave prefers to return NaN which indicates failure of algorithm.
## Tests can be re-instated if full Matlab-compatibility is coded.
%!#assert (logspace (0, Inf, 3), [1, Inf, Inf])
%!#assert (logspace (0, -Inf, 3), [1, 0, 0])
%!assert (logspace (Inf, -Inf, 3), [Inf, 1, 0])
%!assert (logspace (-Inf, 0, 3), [0, NaN, 1])
%!assert (logspace (Inf, 0, 3), [Inf, NaN, 1])
## Test input validation
%!error <Invalid call> logspace ()
%!error logspace ([1, 2; 3, 4], 5, 6)
%!error logspace (1, [1, 2; 3, 4], 6)
%!error logspace (1, 2, [1, 2; 3, 4])
|
