annotate liboctave/str-vec.h @ 10350:12884915a8e4

merge MArray classes & improve Array interface
author Jaroslav Hajek <highegg@gmail.com>
date Sat, 23 Jan 2010 21:41:03 +0100
parents cbc402e64d83
children f9347eac65dc
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
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8678
diff changeset
3 Copyright (C) 1996, 1997, 2000, 2002, 2003, 2005, 2006, 2007, 2009
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 John W. Eaton
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
5
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
7
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
8 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
9 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
10 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
11 option) any later version.
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
12
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
17
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
18 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
19 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
20 <http://www.gnu.org/licenses/>.
1757
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
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_str_vec_h)
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
25 #define octave_str_vec_h 1
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
26
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
27 #include <iosfwd>
5880
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
28 #include <list>
9582
bdcfb756d721 improve error messages for ambiguous graphics property names
John W. Eaton <jwe@octave.org>
parents: 8950
diff changeset
29 #include <set>
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
30 #include <string>
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
31
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
32 #include "Array.h"
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
33
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
34 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5880
diff changeset
35 OCTAVE_API
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
36 string_vector : public Array<std::string>
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
37 {
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
38 public:
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
39
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
40 string_vector (void) : Array<std::string> () { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
41
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
42 explicit string_vector (octave_idx_type n) : Array<std::string> (1, n) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
43
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
44 string_vector (const char *s) : Array<std::string> (1, 1, s) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
45
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
46 string_vector (const std::string& s) : Array<std::string> (1, 1, s) { }
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
47
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
48 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
49
5880
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
50 string_vector (const std::list<std::string>& lst);
84ca47e311b3 [project @ 2006-07-06 22:34:48 by jwe]
jwe
parents: 5690
diff changeset
51
9582
bdcfb756d721 improve error messages for ambiguous graphics property names
John W. Eaton <jwe@octave.org>
parents: 8950
diff changeset
52 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
53
2493
8ed4362aa0d6 [project @ 1996-11-11 02:35:04 by jwe]
jwe
parents: 2431
diff changeset
54 string_vector (const char * const *s);
8ed4362aa0d6 [project @ 1996-11-11 02:35:04 by jwe]
jwe
parents: 2431
diff changeset
55
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
56 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
57
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
58 string_vector& operator = (const string_vector& s)
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
59 {
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
60 if (this != &s)
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3503
diff changeset
61 Array<std::string>::operator = (s);
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1811
diff changeset
62
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
63 return *this;
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
64 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
65
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
66 ~string_vector (void) { }
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
67
6379
41c1deed5613 [project @ 2007-03-02 18:43:20 by jwe]
jwe
parents: 6108
diff changeset
68 bool empty (void) const { return length () == 0; }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
69
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
70 octave_idx_type max_length (void) const
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
71 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
72 octave_idx_type n = length ();
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
73 octave_idx_type longest = 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 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
76 {
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
77 octave_idx_type tmp = elem(i).length ();
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
78
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
79 if (tmp > longest)
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
80 longest = tmp;
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
81 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
82
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
83 return longest;
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
84 }
1757
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
85
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
86 void resize (octave_idx_type n, const std::string& rfv = resize_fill_value ())
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
87 { Array<std::string>::resize (1, n, rfv); }
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
88
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
89 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
90
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4587
diff changeset
91 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
92
8678
e2b4c19c455c redo changeset 4238f2600a17 with fixes to sorting
Jaroslav Hajek <highegg@gmail.com>
parents: 8671
diff changeset
93 string_vector& sort (bool make_uniq = false);
2941
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
94
b779a5b8aed4 [project @ 1997-05-08 02:14:34 by jwe]
jwe
parents: 2937
diff changeset
95 string_vector& uniq (void);
1811
3031937966fb [project @ 1996-01-29 07:30:21 by jwe]
jwe
parents: 1781
diff changeset
96
4392
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
97 string_vector& append (const std::string& s);
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
98
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
99 string_vector& append (const string_vector& sv);
dd108fa566fa [project @ 2003-04-26 17:00:24 by jwe]
jwe
parents: 4220
diff changeset
100
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
101 char **c_str_vec (void) const;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
102
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
103 static void delete_c_str_vec (const char * const*);
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2847
diff changeset
104
5690
161ebd1f3410 [project @ 2006-03-17 06:17:24 by jwe]
jwe
parents: 5307
diff changeset
105 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
106 };
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
107
949303ac0fa1 [project @ 1996-01-22 04:55:29 by jwe]
jwe
parents:
diff changeset
108 #endif