Mercurial > hg > octave-lyh
annotate src/pr-output.h @ 10687:a8ce6bdecce5
Improve documentation strings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 Jun 2010 20:22:38 -0700 |
parents | f3b65e1ae355 |
children | 8a40037533e2 |
rev | line source |
---|---|
1 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2002, 2003, |
8920 | 4 2004, 2005, 2006, 2007, 2008, 2009 John W. Eaton |
1 | 5 |
6 This file is part of Octave. | |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
9 under the terms of the GNU General Public License as published by the | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
1 | 12 |
13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
1 | 21 |
22 */ | |
23 | |
383 | 24 #if !defined (octave_pr_output_h) |
25 #define octave_pr_output_h 1 | |
1 | 26 |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
27 #include <iosfwd> |
1 | 28 |
1651 | 29 #include "oct-cmplx.h" |
30 | |
9732
b4fdfee405b5
remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
31 template <typename T> class Array; |
1738 | 32 class ComplexMatrix; |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
33 class FloatComplexMatrix; |
8891
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
34 class ComplexDiagMatrix; |
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
35 class FloatComplexDiagMatrix; |
4513 | 36 class ComplexNDArray; |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
37 class FloatComplexNDArray; |
1 | 38 class Matrix; |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
39 class FloatMatrix; |
8891
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
40 class DiagMatrix; |
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
41 class FloatDiagMatrix; |
4513 | 42 class NDArray; |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
43 class FloatNDArray; |
1738 | 44 class Range; |
3215 | 45 class boolMatrix; |
4513 | 46 class boolNDArray; |
1572 | 47 class charMatrix; |
4513 | 48 class charNDArray; |
8891
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
49 class PermMatrix; |
3928 | 50 class Cell; |
1 | 51 |
4901 | 52 #include "intNDArray.h" |
53 #include "oct-inttypes.h" | |
54 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
55 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
56 extern OCTINTERP_API void |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
57 octave_print_internal (std::ostream& os, bool d, |
10313 | 58 bool pr_as_read_syntax = false); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
59 |
6109 | 60 extern OCTINTERP_API void |
3523 | 61 octave_print_internal (std::ostream& os, double d, |
10313 | 62 bool pr_as_read_syntax = false); |
625 | 63 |
6109 | 64 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
65 octave_print_internal (std::ostream& os, float d, |
10313 | 66 bool pr_as_read_syntax = false); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
67 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
68 extern OCTINTERP_API void |
3523 | 69 octave_print_internal (std::ostream& os, const Matrix& m, |
10313 | 70 bool pr_as_read_syntax = false, |
71 int extra_indent = 0); | |
625 | 72 |
6109 | 73 extern OCTINTERP_API void |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
74 octave_print_internal (std::ostream& os, const DiagMatrix& m, |
10313 | 75 bool pr_as_read_syntax = false, |
76 int extra_indent = 0); | |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
77 |
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
78 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
79 octave_print_internal (std::ostream& os, const FloatMatrix& m, |
10313 | 80 bool pr_as_read_syntax = false, |
81 int extra_indent = 0); | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
82 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
83 extern OCTINTERP_API void |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
84 octave_print_internal (std::ostream& os, const FloatDiagMatrix& m, |
10313 | 85 bool pr_as_read_syntax = false, |
86 int extra_indent = 0); | |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
87 |
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
88 extern OCTINTERP_API void |
4513 | 89 octave_print_internal (std::ostream& os, const NDArray& nda, |
10313 | 90 bool pr_as_read_syntax = false, |
91 int extra_indent = 0); | |
4513 | 92 |
6109 | 93 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
94 octave_print_internal (std::ostream& os, const FloatNDArray& nda, |
10313 | 95 bool pr_as_read_syntax = false, |
96 int extra_indent = 0); | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
97 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
98 extern OCTINTERP_API void |
3523 | 99 octave_print_internal (std::ostream& os, const Complex& c, |
10313 | 100 bool pr_as_read_syntax = false); |
625 | 101 |
6109 | 102 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
103 octave_print_internal (std::ostream& os, const FloatComplex& c, |
10313 | 104 bool pr_as_read_syntax = false); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
105 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
106 extern OCTINTERP_API void |
3523 | 107 octave_print_internal (std::ostream& os, const ComplexMatrix& cm, |
10313 | 108 bool pr_as_read_syntax = false, |
109 int extra_indent = 0); | |
625 | 110 |
6109 | 111 extern OCTINTERP_API void |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
112 octave_print_internal (std::ostream& os, const ComplexDiagMatrix& cm, |
10313 | 113 bool pr_as_read_syntax = false, |
114 int extra_indent = 0); | |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
115 |
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
116 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
117 octave_print_internal (std::ostream& os, const FloatComplexMatrix& cm, |
10313 | 118 bool pr_as_read_syntax = false, |
119 int extra_indent = 0); | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
120 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
121 extern OCTINTERP_API void |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
122 octave_print_internal (std::ostream& os, const FloatComplexDiagMatrix& cm, |
10313 | 123 bool pr_as_read_syntax = false, |
124 int extra_indent = 0); | |
8625
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
125 |
4d90d21a9cd9
special printing of diagonal matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
126 extern OCTINTERP_API void |
4513 | 127 octave_print_internal (std::ostream& os, const ComplexNDArray& nda, |
10313 | 128 bool pr_as_read_syntax = false, |
129 int extra_indent = 0); | |
4513 | 130 |
6109 | 131 extern OCTINTERP_API void |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
132 octave_print_internal (std::ostream& os, const FloatComplexNDArray& nda, |
10313 | 133 bool pr_as_read_syntax = false, |
134 int extra_indent = 0); | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
135 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7215
diff
changeset
|
136 extern OCTINTERP_API void |
8891
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
137 octave_print_internal (std::ostream& os, const PermMatrix& m, |
10313 | 138 bool pr_as_read_syntax = false, |
139 int extra_indent = 0); | |
8891
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
140 |
d077c590eb88
indicate diag & perm matrices on output
Jaroslav Hajek <highegg@gmail.com>
parents:
8625
diff
changeset
|
141 extern OCTINTERP_API void |
3523 | 142 octave_print_internal (std::ostream& os, const Range& r, |
10313 | 143 bool pr_as_read_syntax = false, |
144 int extra_indent = 0); | |
1 | 145 |
6109 | 146 extern OCTINTERP_API void |
3523 | 147 octave_print_internal (std::ostream& os, const boolMatrix& m, |
10313 | 148 bool pr_as_read_syntax = false, |
149 int extra_indent = 0); | |
3215 | 150 |
6109 | 151 extern OCTINTERP_API void |
4513 | 152 octave_print_internal (std::ostream& os, const boolNDArray& m, |
10313 | 153 bool pr_as_read_syntax = false, |
154 int extra_indent = 0); | |
4513 | 155 |
6109 | 156 extern OCTINTERP_API void |
3523 | 157 octave_print_internal (std::ostream& os, const charMatrix& chm, |
10313 | 158 bool pr_as_read_syntax = false, |
159 int extra_indent = 0, | |
160 bool pr_as_string = false); | |
1355 | 161 |
6109 | 162 extern OCTINTERP_API void |
4655 | 163 octave_print_internal (std::ostream& os, const charNDArray& nda, |
10313 | 164 bool pr_as_read_syntax = false, |
165 int extra_indent = 0, | |
166 bool pr_as_string = false); | |
4513 | 167 |
6109 | 168 extern OCTINTERP_API void |
4925 | 169 octave_print_internal (std::ostream& os, const std::string& s, |
10313 | 170 bool pr_as_read_syntax = false, |
171 int extra_indent = 0); | |
4925 | 172 |
6109 | 173 extern OCTINTERP_API void |
9732
b4fdfee405b5
remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
174 octave_print_internal (std::ostream& os, const Array<std::string>& sa, |
10313 | 175 bool pr_as_read_syntax = false, |
176 int extra_indent = 0); | |
4655 | 177 |
7215 | 178 extern OCTINTERP_API void |
179 octave_print_internal (std::ostream& os, const intNDArray<octave_int8>& sa, | |
10313 | 180 bool pr_as_read_syntax = false, |
181 int extra_indent = 0); | |
7215 | 182 |
183 extern OCTINTERP_API void | |
184 octave_print_internal (std::ostream& os, const intNDArray<octave_uint8>& sa, | |
10313 | 185 bool pr_as_read_syntax = false, |
186 int extra_indent = 0); | |
7215 | 187 |
188 extern OCTINTERP_API void | |
189 octave_print_internal (std::ostream& os, const intNDArray<octave_int16>& sa, | |
10313 | 190 bool pr_as_read_syntax = false, |
191 int extra_indent = 0); | |
7215 | 192 |
193 extern OCTINTERP_API void | |
194 octave_print_internal (std::ostream& os, const intNDArray<octave_uint16>& sa, | |
10313 | 195 bool pr_as_read_syntax = false, |
196 int extra_indent = 0); | |
7215 | 197 |
198 extern OCTINTERP_API void | |
199 octave_print_internal (std::ostream& os, const intNDArray<octave_int32>& sa, | |
10313 | 200 bool pr_as_read_syntax = false, |
201 int extra_indent = 0); | |
7215 | 202 |
203 extern OCTINTERP_API void | |
204 octave_print_internal (std::ostream& os, const intNDArray<octave_uint32>& sa, | |
10313 | 205 bool pr_as_read_syntax = false, |
206 int extra_indent = 0); | |
7215 | 207 |
208 extern OCTINTERP_API void | |
209 octave_print_internal (std::ostream& os, const intNDArray<octave_int64>& sa, | |
10313 | 210 bool pr_as_read_syntax = false, |
211 int extra_indent = 0); | |
4901 | 212 |
7215 | 213 extern OCTINTERP_API void |
214 octave_print_internal (std::ostream& os, const intNDArray<octave_uint64>& sa, | |
10313 | 215 bool pr_as_read_syntax = false, |
216 int extra_indent = 0); | |
7215 | 217 |
218 extern OCTINTERP_API void | |
219 octave_print_internal (std::ostream& os, const octave_int<int8_t>& sa, | |
10313 | 220 bool pr_as_read_syntax = false); |
7215 | 221 |
222 extern OCTINTERP_API void | |
223 octave_print_internal (std::ostream& os, const octave_int<uint8_t>& sa, | |
10313 | 224 bool pr_as_read_syntax = false); |
7215 | 225 |
226 extern OCTINTERP_API void | |
227 octave_print_internal (std::ostream& os, const octave_int<int16_t>& sa, | |
10313 | 228 bool pr_as_read_syntax = false); |
7215 | 229 |
230 extern OCTINTERP_API void | |
231 octave_print_internal (std::ostream& os, const octave_int<uint16_t>& sa, | |
10313 | 232 bool pr_as_read_syntax = false); |
7215 | 233 |
234 extern OCTINTERP_API void | |
235 octave_print_internal (std::ostream& os, const octave_int<int32_t>& sa, | |
10313 | 236 bool pr_as_read_syntax = false); |
7215 | 237 |
238 extern OCTINTERP_API void | |
239 octave_print_internal (std::ostream& os, const octave_int<uint32_t>& sa, | |
10313 | 240 bool pr_as_read_syntax = false); |
7215 | 241 |
242 extern OCTINTERP_API void | |
243 octave_print_internal (std::ostream& os, const octave_int<int64_t>& sa, | |
10313 | 244 bool pr_as_read_syntax = false); |
7215 | 245 |
246 extern OCTINTERP_API void | |
247 octave_print_internal (std::ostream& os, const octave_int<uint64_t>& sa, | |
10313 | 248 bool pr_as_read_syntax = false); |
4901 | 249 |
6109 | 250 extern OCTINTERP_API void |
3933 | 251 octave_print_internal (std::ostream& os, const Cell& cell, |
10313 | 252 bool pr_as_read_syntax = false, |
253 int extra_indent = 0, | |
254 bool pr_as_string = false); | |
3928 | 255 |
5360 | 256 // TRUE means that the dimensions of empty objects should be printed |
257 // like this: x = [](2x0). | |
258 extern bool Vprint_empty_dimensions; | |
259 | |
5759 | 260 // How many levels of structure elements should we print? |
6153 | 261 extern OCTINTERP_API int Vstruct_levels_to_print; |
5759 | 262 |
1 | 263 #endif |