octave-nkf: liboctave/array/chNDArray.h annotate

annotate liboctave/array/chNDArray.h @ 20614:10ec79b47808

use new string_value method to handle value extraction errors * __voronoi__.cc, chol.cc, colamd.cc, fftw.cc: Use new string_value method.

author	John W. Eaton <jwe@octave.org>
date	Thu, 08 Oct 2015 18:15:56 -0400
parents	4197fc428c7d
children

rev	line source
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	1 /*
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	2
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19350 diff changeset	3 Copyright (C) 2003-2015 John W. Eaton
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	4
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	6
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
8373b9b41eee [project @ 2003-09-19 21:47:10 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: 6979 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: 6979 diff changeset	10 option) any later version.
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	11
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	15 for more details.
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	16
8373b9b41eee [project @ 2003-09-19 21:47:10 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: 6979 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: 6979 diff changeset	19 <http://www.gnu.org/licenses/>.
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	20
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	21 */
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	22
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	23 #if !defined (octave_chNDArray_h)
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	24 #define octave_chNDArray_h 1
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	25
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	26 #include <string>
6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	27
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	28 #include "Array.h"
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	29
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	30 #include "mx-defs.h"
8774 b756ce0002db split implementation and interface in mx-op-defs and MArray-defs Jaroslav Hajek <highegg@gmail.com> parents: 8626 diff changeset	31 #include "mx-op-decl.h"
10107 fd262afea1d1 optimize bsxfun for chars Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	32 #include "bsxfun-decl.h"
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	33 #include "str-vec.h"
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	34
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	35 class
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5775 diff changeset	36 OCTAVE_API
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	37 charNDArray : public Array<char>
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	38 {
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	39 public:
5523 451ad352b288 [project @ 2005-10-31 03:18:21 by jwe] jwe parents: 5307 diff changeset	40
9656 b29504415a2e provide NDArray->Matrix->Vector typedef mappers Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	41 typedef charMatrix matrix_type;
b29504415a2e provide NDArray->Matrix->Vector typedef mappers Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	42
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	43 charNDArray (void) : Array<char> () { }
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	44
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	45 charNDArray (const dim_vector& dv) : Array<char> (dv) { }
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	46
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	47 charNDArray (const dim_vector& dv, char val) : Array<char> (dv, val) { }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	48
10267 479c7df0cc96 don't instantiate MArray<char> Jaroslav Hajek <highegg@gmail.com> parents: 10158 diff changeset	49 charNDArray (const charNDArray& a) : Array<char> (a) { }
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	50
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	51 charNDArray (const Array<char>& a) : Array<char> (a) { }
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	52
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	53 charNDArray (char c);
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	54
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	55 charNDArray (const char *s);
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	56
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	57 charNDArray (const std::string& s);
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	58
19350 6c9ea5be96bf Change charMatrix to subclass charNDArray rather than be another Array<char>. Carnë Draug <carandraug@octave.org> parents: 17822 diff changeset	59 charNDArray (const string_vector& s, char fill_value = '\0');
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	60
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	61 charNDArray& operator = (const charNDArray& a)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	62 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	63 Array<char>::operator = (a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	64 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	65 }
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	66
8626 1dce30ab0e72 don't convert NaN to logical in bool expressions John W. Eaton <jwe@octave.org> parents: 7620 diff changeset	67 bool any_element_is_nan (void) const { return false; }
1dce30ab0e72 don't convert NaN to logical in bool expressions John W. Eaton <jwe@octave.org> parents: 7620 diff changeset	68
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	69 // FIXME: this is not quite the right thing.
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	70
4556 773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe] jwe parents: 4532 diff changeset	71 boolNDArray all (int dim = -1) const;
773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe] jwe parents: 4532 diff changeset	72 boolNDArray any (int dim = -1) const;
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	73 charNDArray concat (const charNDArray& rb,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	74 const Array<octave_idx_type>& ra_idx);
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	75 charNDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx);
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4806 diff changeset	76
16370 7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	77 charNDArray max (int dim = -1) const;
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	78 charNDArray max (Array<octave_idx_type>& index, int dim = -1) const;
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	79 charNDArray min (int dim = -1) const;
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	80 charNDArray min (Array<octave_idx_type>& index, int dim = -1) const;
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	81
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	82 charNDArray& insert (const charNDArray& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	83 octave_idx_type r, octave_idx_type c);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	84 charNDArray& insert (const charNDArray& a,
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	85 const Array<octave_idx_type>& ra_idx);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	86
9732 b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops Jaroslav Hajek <highegg@gmail.com> parents: 9656 diff changeset	87 charNDArray squeeze (void) const { return Array<char>::squeeze (); }
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4514 diff changeset	88
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	89 static void increment_index (Array<octave_idx_type>& ra_idx,
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10267 diff changeset	90 const dim_vector& dimensions,
cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10267 diff changeset	91 int start_dimension = 0);
4532 01ee68d18069 [project @ 2003-10-10 00:49:54 by jwe] jwe parents: 4514 diff changeset	92
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5105 diff changeset	93 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx,
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	94 const dim_vector& dimensions);
4556 773a21e4fce8 [project @ 2003-10-28 05:02:10 by jwe] jwe parents: 4532 diff changeset	95
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	96 // i/o
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	97
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	98 // friend std::ostream& operator << (std::ostream& os, const charNDArray& a);
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	99 // friend std::istream& operator >> (std::istream& is, charNDArray& a);
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	100
7620 36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	101 charNDArray diag (octave_idx_type k = 0) const;
36594d5bbe13 Move diag function into the octave_value class David Bateman <dbateman@free.fr> parents: 7503 diff changeset	102
14557 e8e86ae3abbc make diag (x, m, n) return a proper diagonal matrix object (bug #36099) John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	103 charNDArray diag (octave_idx_type m, octave_idx_type n) const;
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	104 };
8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	105
16370 7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	106 extern OCTAVE_API charNDArray min (char d, const charNDArray& m);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	107 extern OCTAVE_API charNDArray min (const charNDArray& m, char d);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	108 extern OCTAVE_API charNDArray min (const charNDArray& a, const charNDArray& b);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	109 extern OCTAVE_API charNDArray max (char d, const charNDArray& m);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	110 extern OCTAVE_API charNDArray max (const charNDArray& m, char d);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	111 extern OCTAVE_API charNDArray max (const charNDArray& a, const charNDArray& b);
7ce21619a4b9 min Matlab compatibility issue (bug #33530) Axel Mathéi <axel.mathei@gmail.com> parents: 15271 diff changeset	112
6708 0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	113 NDS_CMP_OP_DECLS (charNDArray, char, OCTAVE_API)
0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	114 NDS_BOOL_OP_DECLS (charNDArray, char, OCTAVE_API)
6456 7f5316cadaa2 [project @ 2007-03-26 16:18:26 by jwe] jwe parents: 6108 diff changeset	115
6708 0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	116 SND_CMP_OP_DECLS (char, charNDArray, OCTAVE_API)
0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	117 SND_BOOL_OP_DECLS (char, charNDArray, OCTAVE_API)
6456 7f5316cadaa2 [project @ 2007-03-26 16:18:26 by jwe] jwe parents: 6108 diff changeset	118
6708 0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	119 NDND_CMP_OP_DECLS (charNDArray, charNDArray, OCTAVE_API)
0ce71beb1cf3 [project @ 2007-06-13 06:40:48 by jwe] jwe parents: 6456 diff changeset	120 NDND_BOOL_OP_DECLS (charNDArray, charNDArray, OCTAVE_API)
6456 7f5316cadaa2 [project @ 2007-03-26 16:18:26 by jwe] jwe parents: 6108 diff changeset	121
10107 fd262afea1d1 optimize bsxfun for chars Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	122 BSXFUN_STDREL_DECLS (charNDArray, OCTAVE_API)
fd262afea1d1 optimize bsxfun for chars Jaroslav Hajek <highegg@gmail.com> parents: 9812 diff changeset	123
4514 8373b9b41eee [project @ 2003-09-19 21:47:10 by jwe] jwe parents: diff changeset	124 #endif

Mercurial > octave-nkf

annotate liboctave/array/chNDArray.h @ 20614:10ec79b47808