Mercurial > octave-antonio

comparison scripts/strings/isstrprop.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} isstrprop (@var{str}, @var{prop}) 20 ## @deftypefn {Function File} {} isstrprop (@var{str}, @var{prop})
21 ## Test character string properties. For example: 21 ## Test character string properties.
22 ##
23 ## For example:
22 ## 24 ##
23 ## @example 25 ## @example
24 ## @group 26 ## @group
25 ## isstrprop ("abc123", "alpha") 27 ## isstrprop ("abc123", "alpha")
26 ## @result{} [1, 1, 1, 0, 0, 0] 28 ## @result{} [1, 1, 1, 0, 0, 0]
27 ## @end group 29 ## @end group
28 ## @end example 30 ## @end example
29 ## 31 ##
30 ## If @var{str} is a cell array, @code{isstrpop} is applied recursively 32 ## If @var{str} is a cell array, @code{isstrpop} is applied recursively to
31 ## to each element of the cell array. 33 ## each element of the cell array.
32 ## 34 ##
33 ## Numeric arrays are converted to character strings. 35 ## Numeric arrays are converted to character strings.
34 ## 36 ##
35 ## The second argument @var{prop} must be one of 37 ## The second argument @var{prop} must be one of
36 ## 38 ##
54 ## @item @qcode{"xdigit"} 56 ## @item @qcode{"xdigit"}
55 ## True for hexadecimal digits (@nospell{a-fA-F0-9}). 57 ## True for hexadecimal digits (@nospell{a-fA-F0-9}).
56 ## 58 ##
57 ## @item @qcode{"space"} 59 ## @item @qcode{"space"}
58 ## @itemx @qcode{"wspace"} 60 ## @itemx @qcode{"wspace"}
59 ## True for whitespace characters (space, formfeed, newline, carriage 61 ## True for whitespace characters (space, formfeed, newline, carriage return,
60 ## return, tab, vertical tab). 62 ## tab, vertical tab).
61 ## 63 ##
62 ## @item @qcode{"punct"} 64 ## @item @qcode{"punct"}
63 ## True for punctuation characters (printing characters except space 65 ## True for punctuation characters (printing characters except space or
64 ## or letter or digit). 66 ## letter or digit).
65 ## 67 ##
66 ## @item @qcode{"cntrl"} 68 ## @item @qcode{"cntrl"}
67 ## True for control characters. 69 ## True for control characters.
68 ## 70 ##
69 ## @item @qcode{"graph"} 71 ## @item @qcode{"graph"}