octave: scripts/general/validateattributes.m annotate

annotate scripts/general/validateattributes.m @ 21578:683a1beee538

maint: Use "FIXME:" for all code blocks needing further attention. * files-dock-widget.cc, file-editor-tab.cc, file-editor-tab.h, file-editor.cc, octave-qscintilla.cc, octave-qt-link.cc, __ilu__.cc, debug.h, oct-stream.cc, pt-jit.cc, __magick_read__.cc, ov-classdef.cc, pt-stmt.cc, oct-sort.cc, inputParser.m, validateattributes.m, fminunc.m, fsolve.m, fzero.m, __scatter__.m, print.m: Use "FIXME:" for all code blocks needing further attention.

author	Rik <rik@octave.org>
date	Fri, 01 Apr 2016 14:55:13 -0700
parents	f7f97d7e9294
children	ecce63c99c3f

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19069 diff changeset	1 ## Copyright (C) 2013-2015 Carnë Draug
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	2 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	3 ## This file is part of Octave.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	4 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	8 ## your option) any later version.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	9 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	13 ## General Public License for more details.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	14 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	18
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	20 ## @deftypefn {} {} validateattributes (@var{A}, @var{classes}, @var{attributes})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	21 ## @deftypefnx {} {} validateattributes (@var{A}, @var{classes}, @var{attributes}, @var{arg_idx})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	22 ## @deftypefnx {} {} validateattributes (@var{A}, @var{classes}, @var{attributes}, @var{func_name})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	23 ## @deftypefnx {} {} validateattributes (@var{A}, @var{classes}, @var{attributes}, @var{func_name}, @var{arg_name})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20719 diff changeset	24 ## @deftypefnx {} {} validateattributes (@var{A}, @var{classes}, @var{attributes}, @var{func_name}, @var{arg_name}, @var{arg_idx})
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	25 ## Check validity of input argument.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	26 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	27 ## Confirms that the argument @var{A} is valid by belonging to one of
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	28 ## @var{classes}, and holding all of the @var{attributes}. If it does not,
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	29 ## an error is thrown, with a message formatted accordingly. The error
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	30 ## message can be made further complete by the function name @var{fun_name},
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	31 ## the argument name @var{arg_name}, and its position in the input
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	32 ## @var{arg_idx}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	33 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	34 ## @var{classes} must be a cell array of strings (an empty cell array is
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	35 ## allowed) with the name of classes (remember that a class name is case
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	36 ## sensitive). In addition to the class name, the following categories
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	37 ## names are also valid:
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	38 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	39 ## @table @asis
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	40 ## @item @qcode{"float"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	41 ## Floating point value comprising classes @qcode{"double"} and
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	42 ## @qcode{"single"}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	43 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	44 ## @item @qcode{"integer"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	45 ## Integer value comprising classes (u)int8, (u)int16, (u)int32, (u)int64.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	46 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	47 ## @item @qcode{"numeric"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	48 ## Numeric value comprising either a floating point or integer value.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	49 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	50 ## @end table
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	51 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	52 ## @var{attributes} must be a cell array with names of checks for @var{A}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	53 ## Some of them require an additional value to be supplied right after the
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	54 ## name (see details for each below).
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	55 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	56 ## @table @asis
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	57 ## @item @qcode{"<="}
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	58 ## All values are less than or equal to the following value in
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	59 ## @var{attributes}.
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	60 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	61 ## @item @qcode{"<"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	62 ## All values are less than the following value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	63 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	64 ## @item @qcode{">="}
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	65 ## All values are greater than or equal to the following value in
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	66 ## @var{attributes}.
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	67 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	68 ## @item @qcode{">"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	69 ## All values are greater than the following value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	70 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	71 ## @item @qcode{"2d"}
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	72 ## A 2-dimensional matrix. Note that vectors and empty matrices have
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	73 ## 2 dimensions, one of them being of length 1, or both length 0.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	74 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	75 ## @item @qcode{"3d"}
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	76 ## Has no more than 3 dimensions. A 2-dimensional matrix is a 3-D matrix
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	77 ## whose 3rd dimension is of length 1.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	78 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	79 ## @item @qcode{"binary"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	80 ## All values are either 1 or 0.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	81 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	82 ## @item @qcode{"column"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	83 ## Values are arranged in a single column.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	84 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	85 ## @item @qcode{"decreasing"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	86 ## No value is @var{NaN}, and each is less than the preceding one.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	87 ##
20669 0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	88 ## @item @qcode{"diag"}
0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	89 ## Value is a diagonal matrix.
0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	90 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	91 ## @item @qcode{"even"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	92 ## All values are even numbers.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	93 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	94 ## @item @qcode{"finite"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	95 ## All values are finite.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	96 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	97 ## @item @qcode{"increasing"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	98 ## No value is @var{NaN}, and each is greater than the preceding one.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	99 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	100 ## @item @qcode{"integer"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	101 ## All values are integer. This is different than using @code{isinteger}
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	102 ## which only checks its an integer type. This checks that each value in
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	103 ## @var{A} is an integer value, i.e., it has no decimal part.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	104 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	105 ## @item @qcode{"ncols"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	106 ## Has exactly as many columns as the next value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	107 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	108 ## @item @qcode{"ndims"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	109 ## Has exactly as many dimensions as the next value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	110 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	111 ## @item @qcode{"nondecreasing"}
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	112 ## No value is @var{NaN}, and each is greater than or equal to the preceding
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	113 ## one.
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	114 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	115 ## @item @qcode{"nonempty"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	116 ## It is not empty.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	117 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	118 ## @item @qcode{"nonincreasing"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	119 ## No value is @var{NaN}, and each is less than or equal to the preceding one.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	120 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	121 ## @item @qcode{"nonnan"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	122 ## No value is a @code{NaN}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	123 ##
20719 d903cccb8de8 doc: Periodic spellcheck of documentation. Rik <rik@octave.org> parents: 20677 diff changeset	124 ## @item @nospell{@qcode{"nonnegative"}}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	125 ## All values are non negative.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	126 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	127 ## @item @qcode{"nonsparse"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	128 ## It is not a sparse matrix.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	129 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	130 ## @item @qcode{"nonzero"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	131 ## No value is zero.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	132 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	133 ## @item @qcode{"nrows"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	134 ## Has exactly as many rows as the next value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	135 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	136 ## @item @qcode{"numel"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	137 ## Has exactly as many elements as the next value in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	138 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	139 ## @item @qcode{"odd"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	140 ## All values are odd numbers.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	141 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	142 ## @item @qcode{"positive"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	143 ## All values are positive.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	144 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	145 ## @item @qcode{"real"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	146 ## It is a non-complex matrix.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	147 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	148 ## @item @qcode{"row"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	149 ## Values are arranged in a single row.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	150 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	151 ## @item @qcode{"scalar"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	152 ## It is a scalar.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	153 ##
18473 2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585) Rik <rik@octave.org> parents: 18078 diff changeset	154 ## @item @qcode{"size"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	155 ## Its size has length equal to the values of the next in @var{attributes}.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	156 ## The next value must is an array with the length for each dimension. To
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	157 ## ignore the check for a certain dimension, the value of @code{NaN} can be
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	158 ## used.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	159 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	160 ## @item @qcode{"square"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	161 ## Is a square matrix.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	162 ##
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 18038 diff changeset	163 ## @item @qcode{"vector"}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	164 ## Values are arranged in a single vector (column or vector).
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	165 ##
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	166 ## @end table
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	167 ##
19069 efd5cf93013b doc: Move validatestrings into function chapter of manual. Rik <rik@octave.org> parents: 18473 diff changeset	168 ## @seealso{isa, validatestring, inputParser}
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	169 ## @end deftypefn
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	170
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	171 function validateattributes (A, cls, attr, varargin)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	172 if (nargin < 3 \|\| nargin > 6)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	173 print_usage ();
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	174 elseif (! iscellstr (cls))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	175 error ("validateattributes: CLASSES must be a cell array of strings");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	176 elseif (! iscell (attr))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	177 error ("validateattributes: ATTRIBUTES must be a cell array");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	178 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	179
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	180 ## Built start of error message from the extra optional arguments
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	181 func_name = "";
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	182 var_name = "input";
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	183 if (nargin > 3)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	184 fourth = varargin{1};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	185 if (ischar (fourth))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	186 func_name = [fourth ": "];
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	187 elseif (nargin == 4 && valid_arg_idx (fourth))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	188 var_name = sprintf ("input %d", fourth);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	189 else
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	190 error ("validateattributes: 4th input argument must be ARG_IDX or FUNC_NAME");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	191 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	192
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	193 if (nargin > 4)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	194 var_name = varargin{2};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	195 if (! ischar (var_name))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	196 error ("validateattributes: VAR_NAME must be a string");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	197 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	198
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	199 if (nargin > 5)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	200 arg_idx = varargin{3};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	201 if (! valid_arg_idx (arg_idx))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	202 error ("validateattributes: ARG_IDX must be a positive integer");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	203 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	204 var_name = sprintf ("%s (argument #%i)", var_name, arg_idx);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	205 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	206 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	207 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	208 err_ini = [func_name var_name];
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	209
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	210 check_cl = isa (A, cls);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	211 if (! isempty (check_cl) && ! any (check_cl))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	212 ## Allowing for an empty list of classes is Matlab incompatible but
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	213 ## that should count as a just a Matlab bug, not an incompatibility.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	214
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	215 ## Replace the category names with the classes that belong to it.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	216 integer = { "int8" "int16" "int32" "int64" ...
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	217 "uint8" "uint16" "uint32" "uint64"};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	218 float = {"single" "double"};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	219 numeric = {integer{:} float{:}};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	220 cls = replace_cl_group (cls, "integer", integer);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	221 cls = replace_cl_group (cls, "float", float );
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	222 cls = replace_cl_group (cls, "numeric", numeric);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	223 cls = unique (cls);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	224
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	225 classes = sprintf (" %s", cls{:});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	226 error ("%s must be of class:\n\n %s\n\nbut was of class %s",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	227 err_ini, classes, class (A));
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	228 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	229
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	230 ## We use a while loop because some attributes require the following value
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	231 ## in the cell array. Also, we can't just get the boolean value for the
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	232 ## test and check at the end the error message since some of the tests
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	233 ## require some more complex error message.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	234
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	235 ## It may look like that we don't perform enough input check in this
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	236 ## function (e.g., we don't check if there's a value after the size
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	237 ## attribute). The reasoning is that this will be a function mostly used
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	238 ## by developers with fairly static input so any problem would be caught
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	239 ## immediately during that functino development, it's no dependent on the
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	240 ## final user input. In addition, it can be called so many times at the
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	241 ## start of every function, we want it to run specially fast.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	242 idx = 1;
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	243 problem = false; # becomes true when one of the tests fails
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	244 while (idx <= numel (attr))
21578 683a1beee538 maint: Use "FIXME:" for all code blocks needing further attention. Rik <rik@octave.org> parents: 21546 diff changeset	245 ## FIXME: once we use this in Octave core, it might be worthy to find
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	246 ## which attributes are checked more often, and place them in that
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	247 ## order inside the switch block.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	248 switch (tolower (attr{idx++}))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	249 case "2d", problem = ndims (A) != 2;
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	250 case "3d", problem = ndims (A) > 3;
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	251 case "column", problem = ! iscolumn (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	252 case "row", problem = ! isrow (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	253 case "scalar", problem = ! isscalar (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	254 case "vector", problem = ! isvector (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	255 case "square", problem = ! issquare (A);
20669 0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	256 case "diag", problem = ! isdiag (A);
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	257 case "nonempty", problem = isempty (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	258 case "nonsparse", problem = issparse (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	259 case "binary", problem = ! islogical (A) && ...
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	260 any ((A(:) != 1) & (A(:) != 0));
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	261 case "even", problem = any (rem (A(:), 2) != 0);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	262 case "odd", problem = any (mod (A(:), 2) != 1);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	263 case "integer", problem = ! isinteger (A) && ...
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	264 any (ceil (A(:)) != A(:));
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	265 case "real", problem = ! isreal (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	266 case "finite", problem = ! isinteger (A) && ...
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	267 ! all (isfinite (A(:)));
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	268 case "nonnan", problem = ! isinteger (A) && ...
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	269 any (isnan (A(:)));
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	270 case "nonnegative", problem = any (A(:) < 0);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	271 case "nonzero", problem = any (A(:) == 0);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	272 case "positive", problem = any (A(:) <= 0);
19865 e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	273 case "decreasing", problem = (any (isnan (A(:)))
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	274 \|\| any (diff (A(:)) >= 0));
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	275 case "increasing", problem = (any (isnan (A(:)))
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	276 \|\| any (diff (A(:)) <= 0));
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	277 case "nondecreasing", problem = (any (isnan (A(:)))
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	278 \|\| any (diff (A(:)) < 0));
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	279 case "nonincreasing", problem = (any (isnan (A(:)))
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19833 diff changeset	280 \|\| any (diff (A(:)) > 0));
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	281 case "size",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	282 A_size = size (A);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	283 w_size = attr{idx++};
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	284 A_size(isnan (w_size)) = NaN;
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	285 if (! isequaln (A_size, w_size))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	286 A_size_str = sprintf ("%dx", size (A))(1:end-1);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	287 w_size_str = sprintf ("%ix", w_size)(1:end-1);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	288 w_size_str = strrep (w_size_str, "NaN", "N");
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	289 error ("%s must be of size %s but was %s", err_ini, w_size_str, A_size_str);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	290 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	291 case "numel",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	292 if (numel (A) != attr{idx++})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	293 error ("%s must have %d elements", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	294 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	295 case "ncols",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	296 if (columns (A) != attr{idx++})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	297 error ("%s must have %d columns", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	298 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	299 case "nrows",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	300 if (rows (A) != attr{idx++})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	301 error ("%s must have %d rows", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	302 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	303 case "ndims",
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	304 ## Note that a [4 5 1] matrix is not considered to have ndims == 3
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	305 ## but is ok for "3d". This is not a bug.
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	306 if (ndims (A) != attr{idx++})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	307 error ("%s must have %d dimensions", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	308 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	309 case ">"
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	310 if (! all (A(:) > attr{idx++}))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	311 error ("%s must be greater than %f", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	312 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	313 case ">="
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	314 if (! all (A(:) >= attr{idx++}))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	315 error ("%s must be greater than or equal to %f", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	316 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	317 case "<"
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	318 if (! all (A(:) < attr{idx++}))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	319 error ("%s must be less than %f", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	320 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	321 case "<="
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	322 if (! all (A(:) <= attr{idx++}))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	323 error ("%s must be less than or equal to %f", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	324 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	325 otherwise
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	326 error ("validateattributes: unknown ATTRIBUTE %s", attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	327 endswitch
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	328 if (problem)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	329 error ("%s must be %s", err_ini, attr{idx-1});
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	330 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	331 endwhile
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	332 endfunction
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	333
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	334 function retval = valid_arg_idx (arg)
19725 5f2c0ca0ef51 Ensure that numbers passed to integer printf format codes are integers (bug #44245). Rik <rik@octave.org>* parents: 19697 diff changeset	335 retval = isnumeric (arg) && isscalar (arg) && arg > 0 && arg == fix (arg);
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	336 endfunction
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	337
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	338 function cls = replace_cl_group (cls, name, group)
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	339 num_pos = strcmpi (cls, name);
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	340 if (any (num_pos))
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	341 cls(num_pos) = [];
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	342 cls(end+1:end+numel(group)) = group;
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	343 endif
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	344 endfunction
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	345
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19725 diff changeset	346
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	347 %!error <double> validateattributes (rand (5), {"uint8"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	348 %!error <single> validateattributes (uint8 (rand (5)), {"float"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	349 %!error <2d> validateattributes (rand (5, 5, 5), {}, {"2d"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	350 %!error <3d> validateattributes (rand (5, 5, 5, 7), {}, {"3d"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	351 %!error <column> validateattributes (rand (5, 5), {}, {"column"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	352 %!error <column> validateattributes (rand (1, 5), {}, {"column"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	353 %!error <row> validateattributes (rand (5, 5), {}, {"row"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	354 %!error <row> validateattributes (rand (5, 1), {}, {"row"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	355 %!error <scalar> validateattributes (rand (1, 5), {}, {"scalar"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	356 %!error <vector> validateattributes (rand (5), {}, {"vector"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	357 %!error <square> validateattributes (rand (5, 6), {}, {"square"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	358 %!error <nonempty> validateattributes ([], {}, {"nonempty"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	359 %!error <nonsparse> validateattributes (sparse(rand(5)), {}, {"nonsparse"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	360 %!error <binary> validateattributes ("text", {}, {"binary"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	361 %!error <binary> validateattributes ([0 1 0 3 0], {}, {"binary"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	362 %!error <even> validateattributes ([2 3 6 8], {}, {"even"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	363 %!error <even> validateattributes ([2 NaN], {}, {"even"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	364 %!error <odd> validateattributes ([3 4 7 5], {}, {"odd"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	365 %!error <odd> validateattributes ([5 NaN], {}, {"odd"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	366 %!error <integer> validateattributes ([5 5.2 5.7], {}, {"integer"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	367 %!error <real> validateattributes ([5i 8 9], {}, {"real"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	368 %!error <finite> validateattributes ([5i Inf 8], {}, {"finite"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	369 %!error <nonnan> validateattributes ([NaN Inf 8], {}, {"nonnan"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	370 %!error <nonnegative> validateattributes ([7 8 -9], {}, {"nonnegative"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	371 %!error <nonzero> validateattributes ([7 8 0], {}, {"nonzero"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	372 %!error <positive> validateattributes ([7 0 8], {}, {"positive"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	373 %!error <decreasing> validateattributes ([7 8 4 3 -5], {}, {"decreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	374 %!error <decreasing> validateattributes ([7 NaN 4 3 -5], {}, {"decreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	375 %!error <increasing> validateattributes ([7 8 4 9 20], {}, {"increasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	376 %!error <increasing> validateattributes ([7 8 NaN 9 20], {}, {"increasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	377 %!error <nonincreasing> validateattributes ([7 8 4 9 20], {}, {"nonincreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	378 %!error <nonincreasing> validateattributes ([7 8 NaN 9 20], {}, {"nonincreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	379 %!error <nondecreasing> validateattributes ([7 8 4 3 -5], {}, {"nondecreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	380 %!error <nondecreasing> validateattributes ([7 NaN 4 3 -5], {}, {"nondecreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	381 %!error <size> validateattributes (ones (5, 3, 6), {}, {"size", [5 4 7]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	382 %!error <size> validateattributes (ones (5, 3, 6), {}, {"size", [5 NaN 7]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	383 %!error <size> validateattributes (ones (5, 3, 6), {}, {"size", [5 3 6 2]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	384 %!error <elements> validateattributes (ones (6, 3), {}, {"numel", 12})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	385 %!error <columns> validateattributes (ones (6, 2), {}, {"ncols", 3})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	386 %!error <rows> validateattributes (ones (6, 2), {}, {"nrows", 3})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	387 %!error <dimensions> validateattributes (ones (6, 2, 6, 3), {}, {"ndims", 3})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	388 %!error <greater than> validateattributes ([6 7 8 5], {}, {">", 5})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	389 %!error <greater than> validateattributes ([6 7 8 5], {}, {">=", 6})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	390 %!error <less than> validateattributes ([6 7 8 5], {}, {"<", 8})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	391 %!error <less than> validateattributes ([6 7 8 5], {}, {"<=", 7})
20669 0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	392 %!error <diag> validateattributes ([0 0 0; 0 0 0; 1 0 0], {}, {"diag"})
0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	393 %!error <diag> validateattributes (repmat (eye (3), [1 1 3]), {}, {"diag"})
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	394
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	395 %!test
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	396 %! validateattributes (rand (5), {"numeric"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	397 %! validateattributes (rand (5), {"float"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	398 %! validateattributes (rand (5), {"double"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	399 %! validateattributes ("text", {"char"}, {})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	400 %! validateattributes (rand (5), {}, {"2d"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	401 %! validateattributes (rand (5), {}, {"3d"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	402 %! validateattributes (rand (5, 5, 5), {}, {"3d"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	403 %! validateattributes (rand (5, 1), {}, {"column"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	404 %! validateattributes (rand (1, 5), {}, {"row"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	405 %! validateattributes ("a", {}, {"scalar"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	406 %! validateattributes (5, {}, {"scalar"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	407 %! validateattributes (rand (1, 5), {}, {"vector"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	408 %! validateattributes (rand (5, 1), {}, {"vector"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	409 %! validateattributes (rand (5), {}, {"square"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	410 %! validateattributes (rand (5), {}, {"nonempty"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	411 %! validateattributes (rand (5), {}, {"nonsparse"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	412 %! validateattributes ([0 1 0 1 0], {}, {"binary"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	413 %! validateattributes (rand (5) > 0.5, {}, {"binary"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	414 %! validateattributes ([8 4 0 6], {}, {"even"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	415 %! validateattributes ([-1 3 5], {}, {"odd"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	416 %! validateattributes ([8 4 0 6], {}, {"real"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	417 %! validateattributes ([8 4i 0 6], {}, {"finite"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	418 %! validateattributes (uint8 ([8 4]), {}, {"finite"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	419 %! validateattributes ([8 Inf], {}, {"nonnan"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	420 %! validateattributes ([0 7 4], {}, {"nonnegative"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	421 %! validateattributes ([-8 7 4], {}, {"nonzero"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	422 %! validateattributes ([8 7 4], {}, {"positive"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	423 %! validateattributes ([8 7 4 -5], {}, {"decreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	424 %! validateattributes ([-8 -7 4 5], {}, {"increasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	425 %! validateattributes ([8 4 4 -5], {}, {"nonincreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	426 %! validateattributes ([-8 -8 4 5], {}, {"nondecreasing"})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	427 %! validateattributes (rand (4, 6, 7, 2), {}, {"size", [4 6 7 2]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	428 %! validateattributes (rand (4, 6, 7, 2), {}, {"size", [4 NaN 7 2]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	429 %! validateattributes (rand (4, 6, 7, 2), {}, {"size", [4 6 NaN 2 NaN]})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	430 %! validateattributes (rand (6, 2), {}, {"numel", 12})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	431 %! validateattributes (rand (6, 2), {}, {"ncols", 2})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	432 %! validateattributes (rand (6, 2), {}, {"nrows", 6})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	433 %! validateattributes (rand (6, 2, 4, 5), {}, {"ndims", 4})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	434 %! validateattributes ([4 5 6 7], {}, {">", 3})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	435 %! validateattributes ([4 5 6 7], {}, {">=", 4})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	436 %! validateattributes ([4 5 6 7], {}, {"<", 8})
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	437 %! validateattributes ([4 5 6 7], {}, {"<=", 7})
20669 0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	438 %! validateattributes (eye (3), {}, {"diag"})
0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	439 %! validateattributes ([1 0 0; 0 1 0; 0 0 1], {}, {"diag"})
0ec7ce024c92 validateattributes: add diag attribute (bug #46328) Amro <amroamroamro@gmail.com> parents: 19865 diff changeset	440 %! validateattributes (zeros (3), {}, {"diag"})
18038 c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	441
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	442 %!test
c404cec84eb4 New function validaattributes to perform input checking for functions. Carnë Draug <carandraug@octave.org> parents: diff changeset	443 %! validateattributes ([0 1 0 1], {"double", "uint8"}, {"binary", "size", [NaN 4], "nonnan"})

Mercurial > octave

annotate scripts/general/validateattributes.m @ 21578:683a1beee538