1########################################################################
2##
3## Copyright (C) 2019-2021 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## -*- texinfo -*-
27## @deftypefn {} {} mustBeNonsparse (@var{x})
28##
29## Require that input @var{x} is not sparse.
30##
31## Raise an error if the input @var{x} is sparse, as determined by
32## @code{issparse (@var{x})}.
33##
34## @seealso{issparse}
35## @end deftypefn
36
37function mustBeNonsparse (x)
38
39  if (nargin != 1)
40    print_usage ();
41  endif
42
43  if (issparse (x))
44    label = inputname (1);
45    if (isempty (label))
46      label = "input";
47    endif
48    error ("%s must be nonsparse", label);
49  endif
50
51endfunction
52
53
54%!test
55%! mustBeNonsparse ([]);
56%! mustBeNonsparse (42);
57%! mustBeNonsparse (1:100);
58%! mustBeNonsparse ("Hello World");
59
60%!error <Invalid call> mustBeNonsparse ()
61%!error <input must be nonsparse> mustBeNonsparse (sparse (42))
62