octave: libinterp/corefcn/strfns.cc annotate

annotate libinterp/corefcn/strfns.cc @ 20939:b17fda023ca6

maint: Use new C++ archetype in more files. Place input validation first in files. Move declaration of retval down in function to be closer to point of usage. Eliminate else clause after if () error. Use "return ovl()" where it makes sense. * find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, givens.cc, graphics.cc, help.cc, hess.cc, hex2num.cc, input.cc, kron.cc, load-path.cc, load-save.cc, lookup.cc, mappers.cc, matrix_type.cc, mgorth.cc, nproc.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, profiler.cc, psi.cc, quad.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc, sparse.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, chol.cc, colamd.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-re-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc: Use new C++ archetype in more files.

author	Rik <rik@octave.org>
date	Fri, 18 Dec 2015 15:37:22 -0800
parents	1142cf6abc0d
children	48b2ad5ee801

rev	line source
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	1 /*
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19403 diff changeset	3 Copyright (C) 1994-2015 John W. Eaton
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	4
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	6
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	10 option) any later version.
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	11
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	15 for more details.
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	16
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	17 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: 6678 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	19 <http://www.gnu.org/licenses/>.
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	20
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	21 */
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	22
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
1192 b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe] jwe parents: 1009 diff changeset	24 #include <config.h>
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	25 #endif
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	26
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1315 diff changeset	27 #include <cctype>
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	28
8463 a74871446af7 Fchar, Fstrvcat: use queue to avoid duplicate calls to all_strings John W. Eaton <jwe@octave.org> parents: 8462 diff changeset	29 #include <queue>
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5707 diff changeset	30 #include <sstream>
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	31
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	32 #include "dMatrix.h"
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	33
5416 9433f94acd29 [project @ 2005-07-18 18:36:29 by jwe] jwe parents: 5415 diff changeset	34 #include "Cell.h"
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1315 diff changeset	35 #include "defun.h"
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	36 #include "error.h"
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	37 #include "gripes.h"
2366 c90105b99479 [project @ 1996-10-11 23:22:27 by jwe] jwe parents: 2267 diff changeset	38 #include "ov.h"
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1315 diff changeset	39 #include "oct-obj.h"
4457 d7d9ca19960a [project @ 2003-07-11 03:05:38 by jwe] jwe parents: 4358 diff changeset	40 #include "unwind-prot.h"
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	41 #include "utils.h"
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	42
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	43 DEFUN (char, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	44 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	45 @deftypefn {} {} char (@var{x})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	46 @deftypefnx {} {} char (@var{x}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	47 @deftypefnx {} {} char (@var{s1}, @var{s2}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	48 @deftypefnx {} {} char (@var{cell_array})\n\
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	49 Create a string array from one or more numeric matrices, character\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	50 matrices, or cell arrays.\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	51 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	52 Arguments are concatenated vertically. The returned values are padded with\n\
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20172 diff changeset	53 blanks as needed to make each row of the string array have the same length.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	54 Empty input strings are significant and will concatenated in the output.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	55 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	56 For numerical input, each element is converted to the corresponding ASCII\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	57 character. A range error results if an input is outside the ASCII range\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	58 (0-255).\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	59 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	60 For cell arrays, each element is concatenated separately. Cell arrays\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	61 converted through @code{char} can mostly be converted back with\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	62 @code{cellstr}. For example:\n\
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	63 \n\
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	64 @example\n\
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	65 @group\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	66 char ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	67 @result{} [\"abc \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68 \" \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 \"98 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 \"99 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 \"d \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 \"str1 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 \"half \"]\n\
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	74 @end group\n\
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	75 @end example\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	76 @seealso{strvcat, cellstr}\n\
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	77 @end deftypefn")
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	78 {
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	79 octave_value retval;
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	80
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	81 int nargin = args.length ();
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	82
13135 af36cdb552a6 char: return empty string if called with no arguments John W. Eaton <jwe@octave.org> parents: 12900 diff changeset	83 if (nargin == 0)
af36cdb552a6 char: return empty string if called with no arguments John W. Eaton <jwe@octave.org> parents: 12900 diff changeset	84 retval = "";
af36cdb552a6 char: return empty string if called with no arguments John W. Eaton <jwe@octave.org> parents: 12900 diff changeset	85 else if (nargin == 1)
5281 f3266e7dbb99 [project @ 2005-04-14 19:35:20 by jwe] jwe parents: 5280 diff changeset	86 retval = args(0).convert_to_str (true, true,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	87 args(0).is_dq_string () ? '"' : '\'');
13135 af36cdb552a6 char: return empty string if called with no arguments John W. Eaton <jwe@octave.org> parents: 12900 diff changeset	88 else
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	89 {
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	90 int n_elts = 0;
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	91
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	92 int max_len = 0;
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	93
8463 a74871446af7 Fchar, Fstrvcat: use queue to avoid duplicate calls to all_strings John W. Eaton <jwe@octave.org> parents: 8462 diff changeset	94 std::queue<string_vector> args_as_strings;
a74871446af7 Fchar, Fstrvcat: use queue to avoid duplicate calls to all_strings John W. Eaton <jwe@octave.org> parents: 8462 diff changeset	95
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	96 for (int i = 0; i < nargin; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	97 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	98 string_vector s = args(i).xall_strings ("char: unable to convert some args to strings");
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	99
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	100 if (s.numel () > 0)
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	101 n_elts += s.numel ();
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	102 else
349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	103 n_elts += 1;
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	104
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	105 int s_max_len = s.max_length ();
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	106
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	107 if (s_max_len > max_len)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	108 max_len = s_max_len;
8463 a74871446af7 Fchar, Fstrvcat: use queue to avoid duplicate calls to all_strings John W. Eaton <jwe@octave.org> parents: 8462 diff changeset	109
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	110 args_as_strings.push (s);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	111 }
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	112
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	113 string_vector result (n_elts);
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	114
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	115 int k = 0;
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	116
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	117 for (int i = 0; i < nargin; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	118 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	119 string_vector s = args_as_strings.front ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	120 args_as_strings.pop ();
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	121
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	122 int n = s.numel ();
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	123
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	124 if (n > 0)
349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	125 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	126 for (int j = 0; j < n; j++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	127 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	128 std::string t = s[j];
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	129 int t_len = t.length ();
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	130
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	131 if (max_len > t_len)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	132 t += std::string (max_len - t_len, ' ');
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	133
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	134 result[k++] = t;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	135 }
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	136 }
349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	137 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	138 result[k++] = std::string (max_len, ' ');
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	139 }
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	140
5280 25c12c80ccc3 [project @ 2005-04-14 19:19:45 by jwe] jwe parents: 4734 diff changeset	141 retval = octave_value (result, '\'');
4358 83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	142 }
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	143
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	144 return retval;
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	145 }
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe] jwe parents: 4233 diff changeset	146
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	147 /*
13135 af36cdb552a6 char: return empty string if called with no arguments John W. Eaton <jwe@octave.org> parents: 12900 diff changeset	148 %!assert (char (), '');
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	149 %!assert (char (100), "d");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	150 %!assert (char (100,100), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	151 %!assert (char ({100,100}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	152 %!assert (char ([100,100]), ["dd"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	153 %!assert (char ({100,{100}}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	154 %!assert (char (100, [], 100), ["d";" ";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	155 %!assert (char ({100, [], 100}), ["d";" ";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	156 %!assert (char ({100,{100, {""}}}), ["d";"d";" "])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	157 %!assert (char (["a";"be"], {"c", 100}), ["a";"be";"c";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	158 %!assert (char ("a", "bb", "ccc"), ["a "; "bb "; "ccc"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	159 %!assert (char ([65, 83, 67, 73, 73]), "ASCII")
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13135 diff changeset	160
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13135 diff changeset	161 %!test
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13135 diff changeset	162 %! x = char ("foo", "bar", "foobar");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	163 %! assert (x(1,:), "foo ");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	164 %! assert (x(2,:), "bar ");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	165 %! assert (x(3,:), "foobar");
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	166 */
349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	167
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	168 DEFUN (strvcat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	169 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	170 @deftypefn {} {} strvcat (@var{x})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	171 @deftypefnx {} {} strvcat (@var{x}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	172 @deftypefnx {} {} strvcat (@var{s1}, @var{s2}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	173 @deftypefnx {} {} strvcat (@var{cell_array})\n\
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	174 Create a character array from one or more numeric matrices, character\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	175 matrices, or cell arrays.\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	176 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	177 Arguments are concatenated vertically. The returned values are padded with\n\
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20172 diff changeset	178 blanks as needed to make each row of the string array have the same length.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	179 Unlike @code{char}, empty strings are removed and will not appear in the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	180 output.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	181 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	182 For numerical input, each element is converted to the corresponding ASCII\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	183 character. A range error results if an input is outside the ASCII range\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	184 (0-255).\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	185 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	186 For cell arrays, each element is concatenated separately. Cell arrays\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	187 converted through @code{strvcat} can mostly be converted back with\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	188 @code{cellstr}. For example:\n\
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	189 \n\
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	190 @example\n\
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	191 @group\n\
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	192 strvcat ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	193 @result{} [\"abc \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	194 \"98 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	195 \"99 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	196 \"d \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	197 \"str1 \"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	198 \"half \"]\n\
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	199 @end group\n\
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	200 @end example\n\
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	201 @seealso{char, strcat, cstrcat}\n\
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	202 @end deftypefn")
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	203 {
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	204 octave_value retval;
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	205
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	206 int nargin = args.length ();
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	207 int n_elts = 0;
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	208 size_t max_len = 0;
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	209 std::queue<string_vector> args_as_strings;
8463 a74871446af7 Fchar, Fstrvcat: use queue to avoid duplicate calls to all_strings John W. Eaton <jwe@octave.org> parents: 8462 diff changeset	210
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	211 for (int i = 0; i < nargin; i++)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	212 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	213 string_vector s = args(i).xall_strings ("strvcat: unable to convert some args to strings");
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	214
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	215 size_t n = s.numel ();
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	216
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	217 // do not count empty strings in calculation of number of elements
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	218 if (n > 0)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	219 {
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	220 for (size_t j = 0; j < n; j++)
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	221 {
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	222 if (s[j].length () > 0)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	223 n_elts++;
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	224 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	225 }
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	226
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	227 size_t s_max_len = s.max_length ();
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	228
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	229 if (s_max_len > max_len)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	230 max_len = s_max_len;
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	231
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	232 args_as_strings.push (s);
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	233 }
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	234
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	235 string_vector result (n_elts);
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	236
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	237 octave_idx_type k = 0;
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	238
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	239 for (int i = 0; i < nargin; i++)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	240 {
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	241 string_vector s = args_as_strings.front ();
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	242 args_as_strings.pop ();
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	243
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	244 size_t n = s.numel ();
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	245
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	246 if (n > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	247 {
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	248 for (size_t j = 0; j < n; j++)
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	249 {
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	250 std::string t = s[j];
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	251 if (t.length () > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	252 {
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	253 size_t t_len = t.length ();
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	254
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	255 if (max_len > t_len)
196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	256 t += std::string (max_len - t_len, ' ');
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	257
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	258 result[k++] = t;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	259 }
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	260 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10234 diff changeset	261 }
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	262 }
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	263
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	264 retval = octave_value (result, '\'');
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	265
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	266 return retval;
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	267 }
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	268
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	269 /*
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	270 %!assert (strvcat (""), "");
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	271 %!assert (strvcat (100) == "d");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	272 %!assert (strvcat (100,100), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	273 %!assert (strvcat ({100,100}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	274 %!assert (strvcat ([100,100]), ["dd"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	275 %!assert (strvcat ({100,{100}}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	276 %!assert (strvcat (100, [], 100), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	277 %!assert (strvcat ({100, [], 100}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	278 %!assert (strvcat ({100,{100, {""}}}), ["d";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	279 %!assert (strvcat (["a";"be"], {"c", 100}), ["a";"be";"c";"d"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	280 %!assert (strvcat ("a", "bb", "ccc"), ["a "; "bb "; "ccc"])
20166 196871335aa8 Allow call with empty argument list in strcat related functions (bug #44981) Carnë Draug <carandraug@octave.org> parents: 19861 diff changeset	281 %!assert (strvcat (), "")
8462 ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	282 */
ebdf1e058d85 Make strvcat an internal function Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8461 diff changeset	283
8353 349a555729a9 keep empty strings in char Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7528 diff changeset	284
4535 a5f23212a3d8 [project @ 2003-10-16 02:39:15 by jwe] jwe parents: 4457 diff changeset	285 DEFUN (ischar, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	286 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	287 @deftypefn {} {} ischar (@var{x})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	288 Return true if @var{x} is a character array.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	289 @seealso{isfloat, isinteger, islogical, isnumeric, iscellstr, isa}\n\
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3014 diff changeset	290 @end deftypefn")
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	291 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	292 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5765 diff changeset	293 print_usage ();
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	294
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	295 return ovl (args(0).is_string ());
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	296 }
c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	297
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	298 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	299 %!assert (ischar ("a"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	300 %!assert (ischar (["ab";"cd"]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	301 %!assert (ischar ({"ab"}), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	302 %!assert (ischar (1), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	303 %!assert (ischar ([1, 2]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	304 %!assert (ischar ([]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	305 %!assert (ischar ([1, 2; 3, 4]), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	306 %!assert (ischar (""), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	307 %!assert (ischar ("test"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	308 %!assert (ischar (["test"; "ing"]), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	309 %!assert (ischar (struct ("foo", "bar")), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	310
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	311 %!error ischar ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	312 %!error ischar ("test", 1)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13135 diff changeset	313 */
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	314
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	315 static octave_value
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	316 do_strcmp_fun (const octave_value& arg0, const octave_value& arg1,
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	317 octave_idx_type n, const char *fcn_name,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	318 bool (*array_op) (const charNDArray&, const charNDArray&,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	319 octave_idx_type),
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	320 bool (*str_op) (const std::string&, const std::string&,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	321 octave_idx_type))
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	322
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	323 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	324 octave_value retval;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	325
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	326 bool s1_string = arg0.is_string ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	327 bool s1_cell = arg0.is_cell ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	328 bool s2_string = arg1.is_string ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	329 bool s2_cell = arg1.is_cell ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	330
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	331 if (s1_string && s2_string)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	332 retval = array_op (arg0.char_array_value (), arg1.char_array_value (), n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	333 else if ((s1_string && s2_cell) \|\| (s1_cell && s2_string))
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	334 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	335 octave_value str_val, cell_val;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	336
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	337 if (s1_string)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	338 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	339 str_val = arg0;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	340 cell_val = arg1;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	341 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	342 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	343 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	344 str_val = arg1;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	345 cell_val = arg0;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	346 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	347
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	348 const Cell cell = cell_val.cell_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	349 const string_vector str = str_val.all_strings ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	350 octave_idx_type r = str.numel ();
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	351
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	352 if (r == 0 \|\| r == 1)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	353 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	354 // Broadcast the string.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	355
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	356 boolNDArray output (cell_val.dims (), false);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	357
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	358 std::string s = r == 0 ? std::string () : str[0];
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	359
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	360 if (cell_val.is_cellstr ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	361 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	362 const Array<std::string> cellstr = cell_val.cellstr_value ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	363 for (octave_idx_type i = 0; i < cellstr.numel (); i++)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	364 output(i) = str_op (cellstr(i), s, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	365 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	366 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	367 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	368 // FIXME: should we warn here?
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	369 for (octave_idx_type i = 0; i < cell.numel (); i++)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	370 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	371 if (cell(i).is_string ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	372 output(i) = str_op (cell(i).string_value (), s, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	373 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	374 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	375
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	376 retval = output;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	377 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	378 else if (r > 1)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	379 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	380 if (cell.numel () == 1)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	381 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	382 // Broadcast the cell.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	383
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	384 const dim_vector dv (r, 1);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	385 boolNDArray output (dv, false);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	386
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	387 if (cell(0).is_string ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	388 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	389 const std::string str2 = cell(0).string_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	390
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	391 for (octave_idx_type i = 0; i < r; i++)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	392 output(i) = str_op (str[i], str2, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	393 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	394
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	395 retval = output;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	396 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	397 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	398 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	399 // Must match in all dimensions.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	400
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	401 boolNDArray output (cell.dims (), false);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	402
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	403 if (cell.numel () == r)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	404 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	405 if (cell_val.is_cellstr ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	406 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	407 const Array<std::string> cellstr
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	408 = cell_val.cellstr_value ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	409 for (octave_idx_type i = 0; i < cellstr.numel (); i++)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	410 output(i) = str_op (str[i], cellstr(i), n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	411 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	412 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	413 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	414 // FIXME: should we warn here?
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	415 for (octave_idx_type i = 0; i < r; i++)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	416 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	417 if (cell(i).is_string ())
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	418 output(i) = str_op (str[i],
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	419 cell(i).string_value (), n);
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	420 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	421 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	422
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	423 retval = output;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	424 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	425 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	426 retval = false;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	427 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	428 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	429 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	430 else if (s1_cell && s2_cell)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	431 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	432 octave_value cell1_val, cell2_val;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	433 octave_idx_type r1 = arg0.numel (), r2;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	434
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	435 if (r1 == 1)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	436 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	437 // Make the singleton cell2.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	438
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	439 cell1_val = arg1;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	440 cell2_val = arg0;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	441 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	442 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	443 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	444 cell1_val = arg0;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	445 cell2_val = arg1;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	446 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	447
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	448 const Cell cell1 = cell1_val.cell_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	449 const Cell cell2 = cell2_val.cell_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	450 r1 = cell1.numel ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	451 r2 = cell2.numel ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	452
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	453 const dim_vector size1 = cell1.dims ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	454 const dim_vector size2 = cell2.dims ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	455
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	456 boolNDArray output (size1, false);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	457
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	458 if (r2 == 1)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	459 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	460 // Broadcast cell2.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	461
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	462 if (cell2(0).is_string ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	463 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	464 const std::string str2 = cell2(0).string_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	465
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	466 if (cell1_val.is_cellstr ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	467 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	468 const Array<std::string> cellstr = cell1_val.cellstr_value ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20193 diff changeset	469 for (octave_idx_type i = 0; i < cellstr.numel (); i++)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	470 output(i) = str_op (cellstr(i), str2, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	471 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	472 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	473 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	474 // FIXME: should we warn here?
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	475 for (octave_idx_type i = 0; i < r1; i++)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	476 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	477 if (cell1(i).is_string ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	478 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	479 const std::string str1 = cell1(i).string_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	480 output(i) = str_op (str1, str2, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	481 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	482 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	483 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	484 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	485 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	486 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	487 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	488 if (size1 != size2)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20804 diff changeset	489 error ("%s: nonconformant cell arrays", fcn_name);
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	490
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	491 if (cell1.is_cellstr () && cell2.is_cellstr ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	492 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	493 const Array<std::string> cellstr1 = cell1_val.cellstr_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	494 const Array<std::string> cellstr2 = cell2_val.cellstr_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	495 for (octave_idx_type i = 0; i < r1; i++)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	496 output (i) = str_op (cellstr1(i), cellstr2(i), n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	497 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	498 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	499 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	500 // FIXME: should we warn here?
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	501 for (octave_idx_type i = 0; i < r1; i++)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	502 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	503 if (cell1(i).is_string () && cell2(i).is_string ())
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	504 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	505 const std::string str1 = cell1(i).string_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	506 const std::string str2 = cell2(i).string_value ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	507 output(i) = str_op (str1, str2, n);
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	508 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	509 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	510 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	511 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	512
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	513 retval = output;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	514 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	515 else
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	516 retval = false;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	517
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	518 return retval;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	519 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	520
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	521 // If both args are arrays, dimensions may be significant.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	522 static bool
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	523 strcmp_array_op (const charNDArray& s1, const charNDArray& s2, octave_idx_type)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	524 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	525 return (s1.dims () == s2.dims ()
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	526 && std::equal (s1.data (), s1.data () + s1.numel (), s2.data ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	527 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	528
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	529 // Otherwise, just use strings.
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	530 static bool
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	531 strcmp_str_op (const std::string& s1, const std::string& s2,
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	532 octave_idx_type)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	533 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	534 return s1 == s2;
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	535 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	536
5415 1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	537 DEFUN (strcmp, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	538 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	539 @deftypefn {} {} strcmp (@var{s1}, @var{s2})\n\
5415 1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	540 Return 1 if the character strings @var{s1} and @var{s2} are the same,\n\
1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	541 and 0 otherwise.\n\
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	542 \n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	543 If either @var{s1} or @var{s2} is a cell array of strings, then an array\n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	544 of the same size is returned, containing the values described above for\n\
9036 58604c45ca74 Cleanup of data types related documentation Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	545 every member of the cell array. The other argument may also be a cell\n\
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	546 array of strings (of the same size or with only one element), char matrix\n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	547 or character string.\n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	548 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	549 @strong{Caution:} For compatibility with @sc{matlab}, Octave's strcmp\n\
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	550 function returns 1 if the character strings are equal, and 0 otherwise.\n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	551 This is just the opposite of the corresponding C library function.\n\
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: 5531 diff changeset	552 @seealso{strcmpi, strncmp, strncmpi}\n\
5415 1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	553 @end deftypefn")
1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	554 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	555 if (args.length () != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5765 diff changeset	556 print_usage ();
5415 1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	557
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	558 return ovl (do_strcmp_fun (args(0), args(1), 0, "strcmp",
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	559 strcmp_array_op, strcmp_str_op));
5415 1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	560 }
1fbae9f046e3 [project @ 2005-07-18 18:16:12 by jwe] jwe parents: 5307 diff changeset	561
5862 2b35a7fe9302 [project @ 2006-06-20 04:31:56 by jwe] jwe parents: 5823 diff changeset	562 /*
2b35a7fe9302 [project @ 2006-06-20 04:31:56 by jwe] jwe parents: 5823 diff changeset	563 %!shared x
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	564 %! x = char (zeros (0, 2));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	565 %!assert (strcmp ("", x), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	566 %!assert (strcmp (x, ""), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	567 %!assert (strcmp (x, x), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	568 ## %!assert (strcmp ({""}, x), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	569 ## %!assert (strcmp ({x}, ""), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	570 ## %!assert (strcmp ({x}, x), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	571 ## %!assert (strcmp ("", {x}), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	572 ## %!assert (strcmp (x, {""}), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	573 ## %!assert (strcmp (x, {x}), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	574 ## %!assert (strcmp ({x; x}, ""), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	575 ## %!assert (strcmp ({x; x}, {""}), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	576 ## %!assert (strcmp ("", {x; x}), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	577 ## %!assert (strcmp ({""}, {x; x}), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	578 %!assert (strcmp ({"foo"}, x), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	579 %!assert (strcmp ({"foo"}, "foo"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	580 %!assert (strcmp ({"foo"}, x), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	581 %!assert (strcmp (x, {"foo"}), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	582 %!assert (strcmp ("foo", {"foo"}), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	583 %!assert (strcmp (x, {"foo"}), false)
5862 2b35a7fe9302 [project @ 2006-06-20 04:31:56 by jwe] jwe parents: 5823 diff changeset	584 %!shared y
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	585 %! y = char (zeros (2, 0));
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	586 %!assert (strcmp ("", y), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	587 %!assert (strcmp (y, ""), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	588 %!assert (strcmp (y, y), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	589 %!assert (strcmp ({""}, y), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	590 %!assert (strcmp ({y}, ""), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	591 %!assert (strcmp ({y}, y), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	592 %!assert (strcmp ("", {y}), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	593 %!assert (strcmp (y, {""}), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	594 %!assert (strcmp (y, {y}), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	595 %!assert (strcmp ({y; y}, ""), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	596 %!assert (strcmp ({y; y}, {""}), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	597 %!assert (strcmp ("", {y; y}), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	598 %!assert (strcmp ({""}, {y; y}), [true; true])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	599 %!assert (strcmp ({"foo"}, y), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	600 %!assert (strcmp ({"foo"}, y), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	601 %!assert (strcmp (y, {"foo"}), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	602 %!assert (strcmp (y, {"foo"}), [false; false])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	603 %!assert (strcmp ("foobar", "foobar"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	604 %!assert (strcmp ("fooba", "foobar"), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	605
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	606 %!error strcmp ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	607 %!error strcmp ("foo", "bar", 3)
5862 2b35a7fe9302 [project @ 2006-06-20 04:31:56 by jwe] jwe parents: 5823 diff changeset	608 */
2b35a7fe9302 [project @ 2006-06-20 04:31:56 by jwe] jwe parents: 5823 diff changeset	609
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	610 // Apparently, Matlab ignores the dims with strncmp. It also
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	611 static bool
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	612 strncmp_array_op (const charNDArray& s1, const charNDArray& s2,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	613 octave_idx_type n)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	614 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	615 octave_idx_type l1 = s1.numel ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	616 octave_idx_type l2 = s2.numel ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	617 return (n > 0 && n <= l1 && n <= l2
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	618 && std::equal (s1.data (), s1.data () + n, s2.data ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	619 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	620
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	621 // Otherwise, just use strings. Note that we neither extract substrings (which
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	622 // would mean a copy, at least in GCC), nor use string::compare (which is a
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	623 // 3-way compare).
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	624 static bool
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	625 strncmp_str_op (const std::string& s1, const std::string& s2, octave_idx_type n)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	626 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	627 octave_idx_type l1 = s1.length ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	628 octave_idx_type l2 = s2.length ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	629 return (n > 0 && n <= l1 && n <= l2
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	630 && std::equal (s1.data (), s1.data () + n, s2.data ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	631 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	632
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	633 DEFUN (strncmp, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	634 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	635 @deftypefn {} {} strncmp (@var{s1}, @var{s2}, @var{n})\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	636 Return 1 if the first @var{n} characters of strings @var{s1} and @var{s2} are\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	637 the same, and 0 otherwise.\n\
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	638 \n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	639 @example\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	640 @group\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	641 strncmp (\"abce\", \"abcd\", 3)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	642 @result{} 1\n\
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	643 @end group\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	644 @end example\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	645 \n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	646 If either @var{s1} or @var{s2} is a cell array of strings, then an array\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	647 of the same size is returned, containing the values described above for\n\
9036 58604c45ca74 Cleanup of data types related documentation Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	648 every member of the cell array. The other argument may also be a cell\n\
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	649 array of strings (of the same size or with only one element), char matrix\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	650 or character string.\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	651 \n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	652 @example\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	653 @group\n\
6256 83949ae13b2c [project @ 2007-01-30 18:45:59 by jwe] jwe parents: 6250 diff changeset	654 strncmp (\"abce\", @{\"abcd\", \"bca\", \"abc\"@}, 3)\n\
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	655 @result{} [1, 0, 1]\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	656 @end group\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	657 @end example\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	658 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	659 @strong{Caution:} For compatibility with @sc{matlab}, Octave's strncmp\n\
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	660 function returns 1 if the character strings are equal, and 0 otherwise.\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	661 This is just the opposite of the corresponding C library function.\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	662 @seealso{strncmpi, strcmp, strcmpi}\n\
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	663 @end deftypefn")
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	664 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	665 if (args.length () != 3)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	666 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	667
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	668 octave_idx_type n = args(2).idx_type_value ();
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	669
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	670 if (n > 0)
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	671 return ovl (do_strcmp_fun (args(0), args(1), n, "strncmp",
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	672 strncmp_array_op, strncmp_str_op));
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	673 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	674 error ("strncmp: N must be greater than 0");
6250 ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	675 }
ff5e6cf72bda [project @ 2007-01-23 18:37:52 by jwe] jwe parents: 5911 diff changeset	676
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	677 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	678 %!assert (strncmp ("abce", "abc", 3), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	679 %!assert (strncmp (100, 100, 1), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	680 %!assert (strncmp ("abce", {"abcd", "bca", "abc"}, 3), logical ([1, 0, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	681 %!assert (strncmp ("abc", {"abcd", "bca", "abc"}, 4), logical ([0, 0, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	682 %!assert (strncmp ({"abcd", "bca", "abc"},"abce", 3), logical ([1, 0, 1]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	683 %!assert (strncmp ({"abcd", "bca", "abc"},{"abcd", "bca", "abe"}, 3), logical ([1, 1, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	684 %!assert (strncmp ("abc", {"abcd", 10}, 2), logical ([1, 0]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	685
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	686 %!error strncmp ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	687 %!error strncmp ("abc", "def")
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	688 */
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	689
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	690 // case-insensitive character equality functor
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	691 struct icmp_char_eq : public std::binary_function<char, char, bool>
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	692 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	693 bool operator () (char x, char y) const
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	694 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	695 return std::toupper (x) == std::toupper (y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	696 }
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	697 };
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	698
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	699 // strcmpi is equivalent to strcmp in that it checks all dims.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	700 static bool
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	701 strcmpi_array_op (const charNDArray& s1, const charNDArray& s2, octave_idx_type)
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	702 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	703 return (s1.dims () == s2.dims ()
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	704 && std::equal (s1.data (), s1.data () + s1.numel (), s2.data (),
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	705 icmp_char_eq ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	706 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	707
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	708 // Ditto for string.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	709 static bool
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	710 strcmpi_str_op (const std::string& s1, const std::string& s2,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	711 octave_idx_type)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	712 {
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	713 return (s1.size () == s2.size ()
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	714 && std::equal (s1.data (), s1.data () + s1.size (), s2.data (),
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	715 icmp_char_eq ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	716 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	717
10316 9966f1f71c32 use DEFUNX instead of DEFUN for strcmpi and strncmpi John W. Eaton <jwe@octave.org> parents: 10315 diff changeset	718 DEFUNX ("strcmpi", Fstrcmpi, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	719 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	720 @deftypefn {} {} strcmpi (@var{s1}, @var{s2})\n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	721 Return 1 if the character strings @var{s1} and @var{s2} are the same,\n\
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	722 disregarding case of alphabetic characters, and 0 otherwise.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	723 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	724 If either @var{s1} or @var{s2} is a cell array of strings, then an array\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	725 of the same size is returned, containing the values described above for\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	726 every member of the cell array. The other argument may also be a cell\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	727 array of strings (of the same size or with only one element), char matrix\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	728 or character string.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	729 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	730 @strong{Caution:} For compatibility with @sc{matlab}, Octave's strcmp\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	731 function returns 1 if the character strings are equal, and 0 otherwise.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	732 This is just the opposite of the corresponding C library function.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	733 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	734 @strong{Caution:} National alphabets are not supported.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	735 @seealso{strcmp, strncmp, strncmpi}\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	736 @end deftypefn")
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	737 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	738 if (args.length () != 2)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	739 print_usage ();
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	740
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	741 return ovl (do_strcmp_fun (args(0), args(1), 0, "strcmpi",
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	742 strcmpi_array_op, strcmpi_str_op));
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	743 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	744
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	745 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	746 %!assert (strcmpi ("abc123", "ABC123"), true)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	747 */
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	748
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	749 // Like strncmp.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	750 static bool
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	751 strncmpi_array_op (const charNDArray& s1, const charNDArray& s2,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	752 octave_idx_type n)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	753 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	754 octave_idx_type l1 = s1.numel ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	755 octave_idx_type l2 = s2.numel ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	756 return (n > 0 && n <= l1 && n <= l2
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	757 && std::equal (s1.data (), s1.data () + n, s2.data (),
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	758 icmp_char_eq ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	759 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	760
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	761 // Ditto.
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	762 static bool
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	763 strncmpi_str_op (const std::string& s1, const std::string& s2,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	764 octave_idx_type n)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	765 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	766 octave_idx_type l1 = s1.length ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	767 octave_idx_type l2 = s2.length ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	768 return (n > 0 && n <= l1 && n <= l2
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	769 && std::equal (s1.data (), s1.data () + n, s2.data (),
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	770 icmp_char_eq ()));
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	771 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	772
10318 f0ac2fa91733 fix incorrect strncmpi change John W. Eaton <jwe@octave.org> parents: 10316 diff changeset	773 DEFUNX ("strncmpi", Fstrncmpi, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	774 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	775 @deftypefn {} {} strncmpi (@var{s1}, @var{s2}, @var{n})\n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	776 Return 1 if the first @var{n} character of @var{s1} and @var{s2} are the\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	777 same, disregarding case of alphabetic characters, and 0 otherwise.\n\
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	778 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	779 If either @var{s1} or @var{s2} is a cell array of strings, then an array\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	780 of the same size is returned, containing the values described above for\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	781 every member of the cell array. The other argument may also be a cell\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	782 array of strings (of the same size or with only one element), char matrix\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	783 or character string.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	784 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	785 @strong{Caution:} For compatibility with @sc{matlab}, Octave's strncmpi\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	786 function returns 1 if the character strings are equal, and 0 otherwise.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	787 This is just the opposite of the corresponding C library function.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	788 \n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	789 @strong{Caution:} National alphabets are not supported.\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	790 @seealso{strncmp, strcmp, strcmpi}\n\
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	791 @end deftypefn")
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	792 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	793 if (args.length () != 3)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	794 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	795
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	796 octave_idx_type n = args(2).idx_type_value ();
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	797
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	798 if (n > 0)
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	799 return ovl (do_strcmp_fun (args(0), args(1), n, "strncmpi",
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	800 strncmpi_array_op, strncmpi_str_op));
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	801 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	802 error ("strncmpi: N must be greater than 0");
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	803 }
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	804
06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	805 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	806 %!assert (strncmpi ("abc123", "ABC456", 3), true)
10108 06e11df4592d implement built-in strcmpi/strncmpi, reduce some code duplication Jaroslav Hajek <highegg@gmail.com> parents: 9307 diff changeset	807 */
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	808
5690 161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	809 DEFUN (list_in_columns, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	810 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20831 diff changeset	811 @deftypefn {} {} list_in_columns (@var{arg}, @var{width}, @var{prefix})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	812 Return a string containing the elements of @var{arg} listed in columns with\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	813 an overall maximum width of @var{width} and optional prefix @var{prefix}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	814 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	815 The argument @var{arg} must be a cell array of character strings or a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	816 character array.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	817 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	818 If @var{width} is not specified or is an empty matrix, or less than or equal\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	819 to zero, the width of the terminal screen is used. Newline characters are\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19861 diff changeset	820 used to break the lines in the output string. For example:\n\
14093 050bc580cb60 doc: Various docstring improvements before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	821 @c Set example in small font to prevent overfull line\n\
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	822 \n\
14093 050bc580cb60 doc: Various docstring improvements before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	823 @smallexample\n\
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	824 @group\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	825 list_in_columns (@{\"abc\", \"def\", \"ghijkl\", \"mnop\", \"qrs\", \"tuv\"@}, 20)\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	826 @result{} abc mnop\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	827 def qrs\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	828 ghijkl tuv\n\
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	829 \n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	830 whos ans\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	831 @result{}\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	832 Variables in the current scope:\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	833 \n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	834 Attr Name Size Bytes Class\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	835 ==== ==== ==== ===== =====\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	836 ans 1x37 37 char\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	837 \n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	838 Total is 37 elements using 37 bytes\n\
9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	839 @end group\n\
14093 050bc580cb60 doc: Various docstring improvements before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	840 @end smallexample\n\
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	841 \n\
5690 161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	842 @seealso{terminal_size}\n\
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	843 @end deftypefn")
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	844 {
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	845 int nargin = args.length ();
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	846
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	847 if (nargin < 1 \|\| nargin > 3)
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	848 print_usage ();
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	849
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	850 string_vector s = args(0).xall_strings ("list_in_columns: ARG must be a cellstr or char array");
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	851
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	852 int width = -1;
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	853
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	854 if (nargin > 1 && ! args(1).is_empty ())
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	855 width = args(1).xint_value ("list_in_columns: WIDTH must be an integer");
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	856
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	857 std::string prefix;
5690 161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	858
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	859 if (nargin > 2)
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20581 diff changeset	860 prefix = args(2).xstring_value ("list_in_columns: PREFIX must be a string");
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	861
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	862 std::ostringstream buf;
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	863
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	864 s.list_in_columns (buf, width, prefix);
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	865
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	866 return ovl (buf.str ());
5690 161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	867 }
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe] jwe parents: 5674 diff changeset	868
807 c03b179482fc [project @ 1994-10-14 14:21:58 by jwe] jwe parents: diff changeset	869 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	870 %!test
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	871 %! input = {"abc", "def", "ghijkl", "mnop", "qrs", "tuv"};
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	872 %! result = "abc mnop\ndef qrs\nghijkl tuv\n";
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	873 %! assert (list_in_columns (input, 20), result);
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	874 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	875 %! input = ["abc"; "def"; "ghijkl"; "mnop"; "qrs"; "tuv"];
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	876 %! result = "abc mnop \ndef qrs \nghijkl tuv \n";
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	877 %! assert (list_in_columns (input, 20), result);
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	878 %!test
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	879 %! input = ["abc"; "def"; "ghijkl"; "mnop"; "qrs"; "tuv"];
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	880 %! result = " abc mnop \n def qrs \n ghijkl tuv \n";
afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	881 %! assert (list_in_columns (input, 20, " "), result);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	882
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	883 %!error list_in_columns ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	884 %!error list_in_columns (["abc", "def"], 20, 2)
14841 afa5e1d20671 * str-vec.h, str-vec.cc (string_vector::list_in_columns): Accept prefix. John W. Eaton <jwe@octave.org> parents: 14429 diff changeset	885 %!error list_in_columns (["abc", "def"], 20, " ", 3)
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	886 %!error <list_in_columns: WIDTH must be an integer> list_in_columns (["abc", "def"], "a")
8461 9d456730b7a8 strfns.cc: improve documentation strings, add examples and tests Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8372 diff changeset	887 */

Mercurial > octave

annotate libinterp/corefcn/strfns.cc @ 20939:b17fda023ca6