annotate liboctave/str-vec.h @ 14204:704f7895eef0 stable release-3-6-0 release-3.6.0

Version 3.6.0 released. * configure.ac (AC_INIT): Version is now 3.6.0. (OCTAVE_API_VERSION_NUMBER): Now 48. (OCTAVE_RELEASE_DATE): Now 2012-01-15.
author John W. Eaton <jwe@octave.org>
date Sun, 15 Jan 2012 13:02:42 -0500
parents 72c96de7a403
children 13cc11418393
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
1 /*
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
2
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12964
diff changeset
3 Copyright (C) 1996-2012 John W. Eaton
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
4
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
6
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
949303ac0fa1 [project @ 1996-01-22 04:55:29 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: 6379
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: 6379
diff changeset
10 option) any later version.
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
11
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
15 for more details.
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
16
949303ac0fa1 [project @ 1996-01-22 04:55:29 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: 6379
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: 6379
diff changeset
19 <http://www.gnu.org/licenses/>.
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
20
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
21 */
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
22
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_str_vec_h)
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
24 #define octave_str_vec_h 1
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
25
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
26 #include <iosfwd>
5880
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
27 #include <list>
9582
bdcfb756d721 improve error messages for ambiguous graphics property names
John W. Eaton <jwe@octave.org>
parents: 8950
diff changeset
28 #include <set>
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
29 #include <string>
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
30
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
31 #include "Array.h"
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
32
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
33 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5880
diff changeset
34 OCTAVE_API
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
35 string_vector : public Array<std::string>
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
36 {
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
37 public:
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
38
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
39 string_vector (void) : Array<std::string> () { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
40
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
41 explicit string_vector (octave_idx_type n)
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
42 : Array<std::string> (dim_vector (n, 1)) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
43
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
44 string_vector (const char *s)
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
45 : Array<std::string> (dim_vector (1, 1), s) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
46
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
47 string_vector (const std::string& s)
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
48 : Array<std::string> (dim_vector (1, 1), s) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
49
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
50 string_vector (const string_vector& s) : Array<std::string> (s) { }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
51
5880
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
52 string_vector (const std::list<std::string>& lst);
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
53
9582
bdcfb756d721 improve error messages for ambiguous graphics property names
John W. Eaton <jwe@octave.org>
parents: 8950
diff changeset
54 string_vector (const std::set<std::string>& lst);
bdcfb756d721 improve error messages for ambiguous graphics property names
John W. Eaton <jwe@octave.org>
parents: 8950
diff changeset
55
10492
a6b64a7a3769 make feval work with overloaded handles
Jaroslav Hajek <highegg@gmail.com>
parents: 10355
diff changeset
56 string_vector (const Array<std::string>& s)
a6b64a7a3769 make feval work with overloaded handles
Jaroslav Hajek <highegg@gmail.com>
parents: 10355
diff changeset
57 : Array<std::string> (s.as_column ()) { }
a6b64a7a3769 make feval work with overloaded handles
Jaroslav Hajek <highegg@gmail.com>
parents: 10355
diff changeset
58
2493
8ed4362aa0d6 [project @ 1996-11-11 02:35:04 by jwe]
jwe
parents: 2431
diff changeset
59 string_vector (const char * const *s);
8ed4362aa0d6 [project @ 1996-11-11 02:35:04 by jwe]
jwe
parents: 2431
diff changeset
60
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
61 string_vector (const char * const *s, octave_idx_type n);
2493
8ed4362aa0d6 [project @ 1996-11-11 02:35:04 by jwe]
jwe
parents: 2431
diff changeset
62
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
63 string_vector& operator = (const string_vector& s)
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
64 {
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
65 if (this != &s)
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
66 Array<std::string>::operator = (s);
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
67
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
68 return *this;
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
69 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
70
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
71 ~string_vector (void) { }
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
72
6379
41c1deed5613 [project @ 2007-03-02 18:43:20 by jwe]
jwe
parents: 6108
diff changeset
73 bool empty (void) const { return length () == 0; }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
74
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
75 octave_idx_type max_length (void) const
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
76 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
77 octave_idx_type n = length ();
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
78 octave_idx_type longest = 0;
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
79
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
80 for (octave_idx_type i = 0; i < n; i++)
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
81 {
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
82 octave_idx_type tmp = elem(i).length ();
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
83
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
84 if (tmp > longest)
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
85 longest = tmp;
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
86 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
87
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
88 return longest;
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
89 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
90
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
91 void resize (octave_idx_type n, const std::string& rfv = resize_fill_value ())
11574
a83bad07f7e3 attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
92 {
a83bad07f7e3 attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
93 Array<std::string>::resize (dim_vector (n, 1), rfv);
a83bad07f7e3 attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
94 }
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
95
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
96 std::string& operator[] (octave_idx_type i) { return Array<std::string>::elem (i); }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
97
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
98 std::string operator[] (octave_idx_type i) const { return Array<std::string>::elem (i); }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
99
8678
e2b4c19c455c redo changeset 4238f2600a17 with fixes to sorting
Jaroslav Hajek <highegg@gmail.com>
parents: 8671
diff changeset
100 string_vector& sort (bool make_uniq = false);
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
101
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
102 string_vector& uniq (void);
1811
3031937966fb [project @ 1996-01-29 07:30:21 by jwe]
jwe
parents: 1781
diff changeset
103
4392
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
104 string_vector& append (const std::string& s);
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
105
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
106 string_vector& append (const string_vector& sv);
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
107
12964
8ec12d686796 new string_vector::join method
John W. Eaton <jwe@octave.org>
parents: 11574
diff changeset
108 std::string join (const std::string& sep = std::string ()) const;
8ec12d686796 new string_vector::join method
John W. Eaton <jwe@octave.org>
parents: 11574
diff changeset
109
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
110 char **c_str_vec (void) const;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
111
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
112 static void delete_c_str_vec (const char * const*);
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
113
5690
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe]
jwe
parents: 5307
diff changeset
114 std::ostream& list_in_columns (std::ostream&, int width = 0) const;
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
115 };
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
116
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
117 #endif