Mercurial > octave-nkf

comparison scripts/general/validateattributes.m @ 18078:b06a9768b643

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. * plot.txi: Replace "@table @qcode" with "@table @asis". Use "@item @qcode{xx}" for each table item. * file-io.cc (Ffread): Replace "@table @qcode" with "@table @asis". Use "@item @qcode{xx}" for each table item. * validateattributes.m: Replace "@table @qcode" with "@table @asis". Use "@item @qcode{xx}" for each table item.
author Rik <rik@octave.org>
date Wed, 04 Dec 2013 12:05:43 -0800
parents c404cec84eb4
children 2b01c11197d6
comparison
equal deleted inserted replaced
18076:42e6cdc76f4b 18078:b06a9768b643
34 ## @var{classes} must be a cell array of strings (an empty cell array is 34 ## @var{classes} must be a cell array of strings (an empty cell array is
35 ## allowed) with the name of classes (remember that a class name is case 35 ## allowed) with the name of classes (remember that a class name is case
36 ## sensitive). In addition to the class name, the following categories 36 ## sensitive). In addition to the class name, the following categories
37 ## names are also valid: 37 ## names are also valid:
38 ## 38 ##
39 ## @table @qcode 39 ## @table @asis
40 ## @item "float" 40 ## @item @qcode{"float"}
41 ## Floating point value comprising classes @qcode{"double"} and 41 ## Floating point value comprising classes @qcode{"double"} and
42 ## @qcode{"single"}. 42 ## @qcode{"single"}.
43 ## 43 ##
44 ## @item "integer" 44 ## @item @qcode{"integer"}
45 ## Integer value comprising classes (u)int8, (u)int16, (u)int32, (u)int64. 45 ## Integer value comprising classes (u)int8, (u)int16, (u)int32, (u)int64.
46 ## 46 ##
47 ## @item "numeric" 47 ## @item @qcode{"numeric"}
48 ## Numeric value comprising either a floating point or integer value. 48 ## Numeric value comprising either a floating point or integer value.
49 ## 49 ##
50 ## @end table 50 ## @end table
51 ## 51 ##
52 ## @var{attributes} must be a cell array with names of checks for @var{A}. 52 ## @var{attributes} must be a cell array with names of checks for @var{A}.
53 ## Some of them require an additional value to be supplied right after the 53 ## Some of them require an additional value to be supplied right after the
54 ## name (see details for each below). 54 ## name (see details for each below).
55 ## 55 ##
56 ## @table @qcode 56 ## @table @asis
57 ## @item "<=" 57 ## @item @qcode{"<="}
58 ## All values are less than or equal to the following value in @var{attributes}. 58 ## All values are less than or equal to the following value in @var{attributes}.
59 ## 59 ##
60 ## @item "<" 60 ## @item @qcode{"<"}
61 ## All values are less than the following value in @var{attributes}. 61 ## All values are less than the following value in @var{attributes}.
62 ## 62 ##
63 ## @item ">=" 63 ## @item @qcode{">="}
64 ## All values are greater than or equal to the following value in @var{attributes}. 64 ## All values are greater than or equal to the following value in
65 ## 65 ## @var{attributes}.
66 ## @item ">" 66 ##
67 ## @item @qcode{">"}
67 ## All values are greater than the following value in @var{attributes}. 68 ## All values are greater than the following value in @var{attributes}.
68 ## 69 ##
69 ## @item "2d" 70 ## @item @qcode{"2d"}
70 ## A 2 dimensional matrix. Note that vectors and empty matrices have 71 ## A 2-dimensional matrix. Note that vectors and empty matrices have
71 ## 2 dimensions, one of them being of length 1, or both length 0. 72 ## 2 dimensions, one of them being of length 1, or both length 0.
72 ## 73 ##
73 ## @item "3d" 74 ## @item @qcode{"3d"}
74 ## Has no more than 3 dimensions. A 2 dimensional matrix is a 3D matrix 75 ## Has no more than 3 dimensions. A 2-dimensional matrix is a 3-D matrix
75 ## whose 3rd dimension is of length 1. 76 ## whose 3rd dimension is of length 1.
76 ## 77 ##
77 ## @item "binary" 78 ## @item @qcode{"binary"}
78 ## All values are either 1 or 0. 79 ## All values are either 1 or 0.
79 ## 80 ##
80 ## @item "column" 81 ## @item @qcode{"column"}
81 ## Values are arranged in a single column. 82 ## Values are arranged in a single column.
82 ## 83 ##
83 ## @item "decreasing" 84 ## @item @qcode{"decreasing"}
84 ## No value is @var{NaN}, and each is less than the preceding one. 85 ## No value is @var{NaN}, and each is less than the preceding one.
85 ## 86 ##
86 ## @item "even" 87 ## @item @qcode{"even"}
87 ## All values are even numbers. 88 ## All values are even numbers.
88 ## 89 ##
89 ## @item "finite" 90 ## @item @qcode{"finite"}
90 ## All values are finite. 91 ## All values are finite.
91 ## 92 ##
92 ## @item "increasing" 93 ## @item @qcode{"increasing"}
93 ## No value is @var{NaN}, and each is greater than the preceding one. 94 ## No value is @var{NaN}, and each is greater than the preceding one.
94 ## 95 ##
95 ## @item "integer" 96 ## @item @qcode{"integer"}
96 ## All values are integer. This is different than using @code{isinteger} 97 ## All values are integer. This is different than using @code{isinteger}
97 ## which only checks its an integer type. This checks that each value in 98 ## which only checks its an integer type. This checks that each value in
98 ## @var{A} is an integer value, i.e., it has no decimal part. 99 ## @var{A} is an integer value, i.e., it has no decimal part.
99 ## 100 ##
100 ## @item "ncols" 101 ## @item @qcode{"ncols"}
101 ## Has exactly as many columns as the next value in @var{attributes}. 102 ## Has exactly as many columns as the next value in @var{attributes}.
102 ## 103 ##
103 ## @item "ndims" 104 ## @item @qcode{"ndims"}
104 ## Has exactly as many dimensions as the next value in @var{attributes}. 105 ## Has exactly as many dimensions as the next value in @var{attributes}.
105 ## 106 ##
106 ## @item "nondecreasing" 107 ## @item @qcode{"nondecreasing"}
107 ## No value is @var{NaN}, and each is greater than or equal to the preceding one. 108 ## No value is @var{NaN}, and each is greater than or equal to the preceding
108 ## 109 ## one.
109 ## @item "nonempty" 110 ##
111 ## @item @qcode{"nonempty"}
110 ## It is not empty. 112 ## It is not empty.
111 ## 113 ##
112 ## @item "nonincreasing" 114 ## @item @qcode{"nonincreasing"}
113 ## No value is @var{NaN}, and each is less than or equal to the preceding one. 115 ## No value is @var{NaN}, and each is less than or equal to the preceding one.
114 ## 116 ##
115 ## @item "nonnan" 117 ## @item @qcode{"nonnan"}
116 ## No value is a @code{NaN}. 118 ## No value is a @code{NaN}.
117 ## 119 ##
118 ## @item "nonnegative" 120 ## @item @qcode{"non-negative"}
119 ## All values are non negative. 121 ## All values are non negative.
120 ## 122 ##
121 ## @item "nonsparse" 123 ## @item @qcode{"nonsparse"}
122 ## It is not a sparse matrix. 124 ## It is not a sparse matrix.
123 ## 125 ##
124 ## @item "nonzero" 126 ## @item @qcode{"nonzero"}
125 ## No value is zero. 127 ## No value is zero.
126 ## 128 ##
127 ## @item "nrows" 129 ## @item @qcode{"nrows"}
128 ## Has exactly as many rows as the next value in @var{attributes}. 130 ## Has exactly as many rows as the next value in @var{attributes}.
129 ## 131 ##
130 ## @item "numel" 132 ## @item @qcode{"numel"}
131 ## Has exactly as many elements as the next value in @var{attributes}. 133 ## Has exactly as many elements as the next value in @var{attributes}.
132 ## 134 ##
133 ## @item "odd" 135 ## @item @qcode{"odd"}
134 ## All values are odd numbers. 136 ## All values are odd numbers.
135 ## 137 ##
136 ## @item "positive" 138 ## @item @qcode{"positive"}
137 ## All values are positive. 139 ## All values are positive.
138 ## 140 ##
139 ## @item "real" 141 ## @item @qcode{"real"}
140 ## It is a non-complex matrix. 142 ## It is a non-complex matrix.
141 ## 143 ##
142 ## @item "row" 144 ## @item @qcode{"row"}
143 ## Values are arranged in a single row. 145 ## Values are arranged in a single row.
144 ## 146 ##
145 ## @item "scalar" 147 ## @item @qcode{"scalar"}
146 ## It is a scalar. 148 ## It is a scalar.
147 ## 149 ##
148 ## @item "size", 150 ## @item @qcode{"size",}
149 ## Its size has length equal to the values of the next in @var{attributes}. 151 ## Its size has length equal to the values of the next in @var{attributes}.
150 ## The next value must is an array with the length for each dimension. To 152 ## The next value must is an array with the length for each dimension. To
151 ## ignore the check for a certain dimension, the value of @code{NaN} can be 153 ## ignore the check for a certain dimension, the value of @code{NaN} can be
152 ## used. 154 ## used.
153 ## 155 ##
154 ## @item "square" 156 ## @item @qcode{"square"}
155 ## Is a square matrix. 157 ## Is a square matrix.
156 ## 158 ##
157 ## @item "vector" 159 ## @item @qcode{"vector"}
158 ## Values are arranged in a single vector (column or vector). 160 ## Values are arranged in a single vector (column or vector).
159 ## 161 ##
160 ## @end table 162 ## @end table
161 ## 163 ##
162 ## @seealso{nargin, varargin, isa, validatestring} 164 ## @seealso{nargin, varargin, isa, validatestring}