Mercurial > octave-antonio

annotate scripts/strings/strtrim.m @ 9036:58604c45ca74

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleanup of data types related documentation Files: data.texi, numbers.texi, strings.texi, container.texi Use two spaces after a period for increased readibility in Info browser Spellcheck
author Rik <rdrider0-list@yahoo.com>
date Sat, 21 Mar 2009 15:52:41 -0700
parents eb63fbe60fab
children 01ddaedd6ad5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
1 ## Copyright (C) 1996, 2007, 2008, 2009 Kurt Hornik
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
2 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
4 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
0d11a12643f1 [project @ 2007-10-08 18:23:44 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: 6975
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: 6975
diff changeset
8 ## your option) any later version.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
9 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
14 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 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: 6975
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: 6975
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
18
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
19 ## -*- texinfo -*-
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
20 ## @deftypefn {Function File} {} strtrim (@var{s})
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
21 ## Remove leading and trailing blanks and nulls from @var{s}. If
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
22 ## @var{s} is a matrix, @var{strtrim} trims each row to the length of
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
23 ## longest string. If @var{s} is a cell array, operate recursively on
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
24 ## each element of the cell array. For example:
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
25 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
26 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
27 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
28 ## strtrim (" abc ")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
29 ## @result{} "abc"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
30 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
31 ## strtrim ([" abc "; " def "])
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
32 ## @result{} ["abc "; " def"]
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
33 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
34 ## @end example
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
35 ## @end deftypefn
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
36
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
37 ## Author: John Swensen <jpswensen@jhu.edu>
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
38
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
39 ## This function was derived from deblank.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
40
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
41 function s = strtrim (s)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
42
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
43 if (nargin != 1)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
44 print_usage ();
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
45 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
46
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
47 if (ischar (s))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
48
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
49 k = find (! isspace (s) & s != "\0");
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
50 if (isempty (s) || isempty (k))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
51 s = "";
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
52 else
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
53 s = s(:,ceil (min (k) / rows (s)):ceil (max (k) / rows (s)));
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
54 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
55
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
56 elseif (iscell(s))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
57
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
58 s = cellfun (@strtrim, s, "UniformOutput", false);
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
59
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
60 else
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
61 error ("strtrim: expecting string argument");
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
62 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
63
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
64 endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
65
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
66 %!error <Invalid call to strtrim> strtrim();
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
67 %!error <Invalid call to strtrim> strtrim("abc", "def");
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
68 %!assert (strtrim (" abc "), "abc");
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
69 %!assert (strtrim ([" abc "; " def "]), ["abc "; " def"]);