annotate liboctave/Array-util.h @ 10512:aac9f4265048

rewrite sparse indexed assignment
author Jaroslav Hajek <highegg@gmail.com>
date Tue, 13 Apr 2010 12:36:21 +0200
parents d47802f0e557
children 8645b7087859
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
1 /*
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
2
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8290
diff changeset
3 Copyright (C) 2000, 2003, 2004, 2005, 2006, 2007, 2008 John W. Eaton
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
4
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
6
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
19bfd295f400 [project @ 2003-11-10 17:18:48 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: 6108
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: 6108
diff changeset
10 option) any later version.
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
11
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
15 for more details.
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
16
19bfd295f400 [project @ 2003-11-10 17:18:48 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: 6108
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: 6108
diff changeset
19 <http://www.gnu.org/licenses/>.
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
20
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
21 */
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
22
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_Array_util_h)
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
24 #define octave_Array_util_h 1
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
25
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
26 #include <cassert>
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
27
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
28 #include "Array.h"
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
29 #include "dim-vector.h"
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
30 #include "idx-vector.h"
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
31 #include "lo-error.h"
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
32
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
33 extern OCTAVE_API bool index_in_bounds (const Array<octave_idx_type>& ra_idx,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
34 const dim_vector& dimensions);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
35
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
36 extern OCTAVE_API void increment_index (Array<octave_idx_type>& ra_idx,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
37 const dim_vector& dimensions,
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
38 int start_dimension = 0);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
39
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
40 extern OCTAVE_API octave_idx_type get_scalar_idx (Array<octave_idx_type>& idx, dim_vector& dims);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
41
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
42 extern OCTAVE_API octave_idx_type num_ones (const Array<octave_idx_type>& ra_idx);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
43
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
44 extern OCTAVE_API bool is_scalar (const dim_vector& dim);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
45
7642
9a4541c622b5 refactor Array::assignN dimensioning code for empty initial matrices
David Bateman <dbateman@free.fr>
parents: 7246
diff changeset
46 extern OCTAVE_API bool is_vector (const dim_vector& dim);
9a4541c622b5 refactor Array::assignN dimensioning code for empty initial matrices
David Bateman <dbateman@free.fr>
parents: 7246
diff changeset
47
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
48 extern OCTAVE_API bool any_ones (const Array<octave_idx_type>& arr);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
49
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
50 extern OCTAVE_API octave_idx_type compute_index (const Array<octave_idx_type>& ra_idx, const dim_vector& dims);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
51
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
52 extern OCTAVE_API Array<octave_idx_type> conv_to_int_array (const Array<idx_vector>& a);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
53
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
54 extern OCTAVE_API Array<idx_vector> conv_to_array (const idx_vector *tmp, const octave_idx_type len);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
55
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
56 extern OCTAVE_API dim_vector freeze (Array<idx_vector>& ra_idx,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
57 const dim_vector& dimensions, int resize_ok);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
58
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
59 extern OCTAVE_API bool vector_equivalent (const dim_vector& dv);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
60
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
61 extern OCTAVE_API bool all_ok (const Array<idx_vector>& ra_idx);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
62
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
63 extern OCTAVE_API bool any_orig_empty (const Array<idx_vector>& ra_idx);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
64
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
65 extern OCTAVE_API bool all_colon_equiv (const Array<idx_vector>& ra_idx,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
66 const dim_vector& frozen_lengths);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
67
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
68 extern OCTAVE_API bool all_ones (const Array<octave_idx_type>& arr);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
69
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
70 extern OCTAVE_API Array<octave_idx_type> get_elt_idx (const Array<idx_vector>& ra_idx,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
71 const Array<octave_idx_type>& result_idx);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
72
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
73 extern OCTAVE_API Array<octave_idx_type> get_ra_idx (octave_idx_type idx, const dim_vector& dims);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
74
8290
7cbe01c21986 improve dense array indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 7922
diff changeset
75 extern OCTAVE_API dim_vector zero_dims_inquire (const Array<idx_vector>& ia,
7cbe01c21986 improve dense array indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 7922
diff changeset
76 const dim_vector& rhdv);
7cbe01c21986 improve dense array indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 7922
diff changeset
77
7cbe01c21986 improve dense array indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 7922
diff changeset
78 extern OCTAVE_API dim_vector zero_dims_inquire (const idx_vector& i, const idx_vector& j,
7cbe01c21986 improve dense array indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 7922
diff changeset
79 const dim_vector& rhdv);
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
80
9479
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
81 extern OCTAVE_API idx_vector sub2ind (const dim_vector& dv, const Array<idx_vector>& idxa);
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
82
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
83 extern OCTAVE_API Array<idx_vector> ind2sub (const dim_vector& dv, const idx_vector& idx);
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
84
7241
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
85 struct
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
86 permute_vector
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
87 {
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
88 octave_idx_type pidx;
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
89 octave_idx_type iidx;
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
90 };
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
91
7246
f81e80674b9b [project @ 2007-12-04 15:49:12 by jwe]
jwe
parents: 7241
diff changeset
92 extern int OCTAVE_API permute_vector_compare (const void *a, const void *b);
7241
da540e715d05 [project @ 2007-12-03 22:55:20 by jwe]
jwe
parents: 7017
diff changeset
93
10370
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
94 extern OCTAVE_API const char *error_id_nonconformant_args;
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
95
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
96 extern OCTAVE_API const char *error_id_index_out_of_bounds;
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
97
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
98 extern OCTAVE_API const char *error_id_invalid_index;
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
99
7922
935be827eaf8 error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents: 7642
diff changeset
100 extern void OCTAVE_API gripe_nan_to_logical_conversion (void);
935be827eaf8 error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents: 7642
diff changeset
101
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
102 extern void OCTAVE_API gripe_nonconformant (const char *op, int op1_len, int op2_len);
4669
334a27c8f453 [project @ 2003-11-26 07:02:42 by jwe]
jwe
parents: 4593
diff changeset
103
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5607
diff changeset
104 extern void OCTAVE_API gripe_nonconformant (const char *op, int op1_nr, int op1_nc,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
105 int op2_nr, int op2_nc);
4669
334a27c8f453 [project @ 2003-11-26 07:02:42 by jwe]
jwe
parents: 4593
diff changeset
106
334a27c8f453 [project @ 2003-11-26 07:02:42 by jwe]
jwe
parents: 4593
diff changeset
107
10366
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
108 extern void OCTAVE_API gripe_nonconformant (const char *op, const dim_vector& op1_dims,
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
109 const dim_vector& op2_dims);
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
110
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
111 extern void OCTAVE_API gripe_index_out_of_range (int nd, int dim,
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
112 octave_idx_type iext, octave_idx_type ext);
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
113
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
114 extern void OCTAVE_API gripe_del_index_out_of_range (bool is1d, octave_idx_type iext,
e5ae13b8b2c2 improve Array indexing error messages
Jaroslav Hajek <highegg@gmail.com>
parents: 10312
diff changeset
115 octave_idx_type ext);
4669
334a27c8f453 [project @ 2003-11-26 07:02:42 by jwe]
jwe
parents: 4593
diff changeset
116
10489
d47802f0e557 Back out changeset 4e64fbbd5c58
Jaroslav Hajek <highegg@gmail.com>
parents: 10486
diff changeset
117 extern void OCTAVE_API gripe_invalid_index (void);
10370
9c4daf174387 implement IDs for common liboctave exceptions
Jaroslav Hajek <highegg@gmail.com>
parents: 10366
diff changeset
118
10425
0677c5d80b77 rewrite 1D sparse indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 10370
diff changeset
119 extern void OCTAVE_API gripe_invalid_resize (void);
0677c5d80b77 rewrite 1D sparse indexing
Jaroslav Hajek <highegg@gmail.com>
parents: 10370
diff changeset
120
10512
aac9f4265048 rewrite sparse indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents: 10489
diff changeset
121 extern void OCTAVE_API gripe_invalid_assignment_size (void);
aac9f4265048 rewrite sparse indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents: 10489
diff changeset
122
aac9f4265048 rewrite sparse indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents: 10489
diff changeset
123 extern void OCTAVE_API gripe_assignment_dimension_mismatch (void);
aac9f4265048 rewrite sparse indexed assignment
Jaroslav Hajek <highegg@gmail.com>
parents: 10489
diff changeset
124
4588
19bfd295f400 [project @ 2003-11-10 17:18:48 by jwe]
jwe
parents:
diff changeset
125 #endif