Mercurial > hg > octave-lyh
annotate liboctave/chNDArray.h @ 14819:67b6b47a22f6
doc: Clarify docstrings for canonicalize_file_name, make_absolute_filename
* syscalls.cc (canonicalize_file_name): Clarify docstring.
* utils.cc (make_absolute_filename): Clarify docstring.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 29 Jun 2012 13:38:28 -0700 |
| parents | 13cc11418393 |
| children |
| rev | line source |
|---|---|
| 4514 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
3 Copyright (C) 2003-2012 John W. Eaton |
| 4514 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 4514 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 4514 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_charNDArray_h) | |
| 24 #define octave_charNDArray_h 1 | |
| 25 | |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
26 #include "Array.h" |
| 4514 | 27 #include "chMatrix.h" |
| 28 | |
| 29 #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
|
30 #include "mx-op-decl.h" |
|
10107
fd262afea1d1
optimize bsxfun for chars
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
31 #include "bsxfun-decl.h" |
| 4514 | 32 |
| 33 class | |
| 6108 | 34 OCTAVE_API |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
35 charNDArray : public Array<char> |
| 4514 | 36 { |
| 37 public: | |
| 5523 | 38 |
|
9656
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
39 typedef charMatrix matrix_type; |
|
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
40 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
41 charNDArray (void) : Array<char> () { } |
| 4514 | 42 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
43 charNDArray (const dim_vector& dv) : Array<char> (dv) { } |
| 4514 | 44 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
45 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
|
46 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
47 charNDArray (const charNDArray& a) : Array<char> (a) { } |
| 4514 | 48 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
49 charNDArray (const charMatrix& a) : Array<char> (a) { } |
| 4514 | 50 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
51 charNDArray (char c) : Array<char> (charMatrix (c)) { } |
| 4514 | 52 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
53 charNDArray (const char *s) : Array<char> (charMatrix (s)) { } |
| 4514 | 54 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
55 charNDArray (const std::string& s) : Array<char> (charMatrix (s)) { } |
| 4514 | 56 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
57 charNDArray (const string_vector& s) : Array<char> (charMatrix (s)) { } |
| 4514 | 58 |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
59 charNDArray (const Array<char>& a) : Array<char> (a) { } |
| 4514 | 60 |
| 61 charNDArray& operator = (const charNDArray& a) | |
| 62 { | |
|
10267
479c7df0cc96
don't instantiate MArray<char>
Jaroslav Hajek <highegg@gmail.com>
parents:
10158
diff
changeset
|
63 Array<char>::operator = (a); |
| 4514 | 64 return *this; |
| 65 } | |
| 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 |
| 5775 | 69 // FIXME -- this is not quite the right thing. |
| 4514 | 70 |
| 4556 | 71 boolNDArray all (int dim = -1) const; |
| 72 boolNDArray any (int dim = -1) const; | |
| 5275 | 73 charNDArray concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx); |
| 74 charNDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 4915 | 75 |
| 5275 | 76 charNDArray& insert (const charNDArray& a, octave_idx_type r, octave_idx_type c); |
| 77 charNDArray& insert (const charNDArray& a, 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
|
78 |
| 4514 | 79 charMatrix matrix_value (void) const; |
| 80 | |
|
9732
b4fdfee405b5
remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
9656
diff
changeset
|
81 charNDArray squeeze (void) const { return Array<char>::squeeze (); } |
| 4532 | 82 |
| 5275 | 83 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
|
84 const dim_vector& dimensions, |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10267
diff
changeset
|
85 int start_dimension = 0); |
| 4532 | 86 |
| 5275 | 87 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10267
diff
changeset
|
88 const dim_vector& dimensions); |
| 4556 | 89 |
| 4514 | 90 // i/o |
| 91 | |
| 92 // friend std::ostream& operator << (std::ostream& os, const charNDArray& a); | |
| 93 // friend std::istream& operator >> (std::istream& is, charNDArray& a); | |
| 94 | |
|
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
95 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
|
96 |
|
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
|
97 charNDArray diag (octave_idx_type m, octave_idx_type n) const; |
| 4514 | 98 }; |
| 99 | |
| 6708 | 100 NDS_CMP_OP_DECLS (charNDArray, char, OCTAVE_API) |
| 101 NDS_BOOL_OP_DECLS (charNDArray, char, OCTAVE_API) | |
| 6456 | 102 |
| 6708 | 103 SND_CMP_OP_DECLS (char, charNDArray, OCTAVE_API) |
| 104 SND_BOOL_OP_DECLS (char, charNDArray, OCTAVE_API) | |
| 6456 | 105 |
| 6708 | 106 NDND_CMP_OP_DECLS (charNDArray, charNDArray, OCTAVE_API) |
| 107 NDND_BOOL_OP_DECLS (charNDArray, charNDArray, OCTAVE_API) | |
| 6456 | 108 |
|
10107
fd262afea1d1
optimize bsxfun for chars
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
109 BSXFUN_STDREL_DECLS (charNDArray, OCTAVE_API) |
|
fd262afea1d1
optimize bsxfun for chars
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
110 |
| 4514 | 111 #endif |