Mercurial > octave-antonio

annotate scripts/strings/isletter.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 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
1 ## Copyright (C) 1998-2015 John W. Eaton
3169
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
2 ##
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
4 ##
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
3169
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
9 ##
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
14 ##
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3169
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
18
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 3426
diff changeset
19 ## -*- texinfo -*-
3501
8b21bcbc1080 [project @ 2000-01-31 06:43:15 by jwe]
jwe
parents: 3500
diff changeset
20 ## @deftypefn {Function File} {} isletter (@var{s})
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
21 ## Return a logical array which is true where the elements of @var{s}
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
22 ## are letters and false where they are not.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
23 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## This is an alias for the @code{isalpha} function.
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
25 ## @seealso{isalpha, isdigit, ispunct, isspace, iscntrl, isalnum}
3407
5e0a0b1cba43 [project @ 2000-01-06 03:13:55 by jwe]
jwe
parents: 3175
diff changeset
26 ## @end deftypefn
3169
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
27
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
28 ## Author: jwe
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
29
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
30 function retval = isletter (s)
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
31
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
32 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
33 print_usage ();
3169
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
34 endif
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
35
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
36 retval = isalpha (s);
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
37
6216bc89fb65 [project @ 1998-04-21 03:14:49 by jwe]
jwe
parents:
diff changeset
38 endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
39
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
40
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41 %!error isletter ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
42 %!error isletter ("a", "b")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43