annotate src/ov-streamoff.cc @ 7091:5608935ff522 ss-2-9-16

[project @ 2007-10-31 21:26:39 by jwe]
author jwe
date Wed, 31 Oct 2007 21:29:24 +0000
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
1 /*
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 2003, 2004, 2005, 2006, 2007 John W. Eaton
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
4
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
6
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
bd2067547b40 [project @ 2003-11-23 08:07:52 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: 5823
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: 5823
diff changeset
10 option) any later version.
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
11
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
15 for more details.
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
16
bd2067547b40 [project @ 2003-11-23 08:07:52 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: 5823
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: 5823
diff changeset
19 <http://www.gnu.org/licenses/>.
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
20
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
21 */
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
22
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
24 #include <config.h>
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
25 #endif
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
26
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
27 #include <iostream>
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
28
4646
eff8f977508c [project @ 2003-11-23 18:13:19 by jwe]
jwe
parents: 4645
diff changeset
29 #include "so-array.h"
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
30
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
31 #include "defun.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
32 #include "error.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
33 #include "gripes.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
34 #include "ov-streamoff.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
35 #include "oct-obj.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
36 #include "utils.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
37 #include "ov-base-mat.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
38 #include "ov-base-mat.cc"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
39
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
40 template class octave_base_matrix<streamoff_array>;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
41
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
42 DEFINE_OCTAVE_ALLOCATOR (octave_streamoff);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
43
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
44 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_streamoff,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
45 "streamoff", "streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
46
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
47 std::streamoff
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
48 octave_streamoff::streamoff_value (void) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
49 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
50 std::streamoff retval (-1);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
51
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
52 if (numel () > 0)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
53 {
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents: 5775
diff changeset
54 gripe_implicit_conversion ("Octave:array-as-scalar",
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents: 5775
diff changeset
55 "streamoff array", "scalar streamoff");
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
56
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
57 retval = matrix (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
58 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
59 else
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
60 gripe_invalid_conversion ("streamoff array", "scalar streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
61
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
62 return retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
63 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
64
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
65 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
66 octave_streamoff::print (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
67 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
68 print_raw (os);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
69 newline (os);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
70 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
71
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
72 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
73 octave_streamoff::print_raw (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
74 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
75 dim_vector dv = matrix.dims ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
76 os << "<" << dv.str () << " streamoff object>";
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
77 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
78
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
79 DEFUN (isstreamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
80 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
81 @deftypefn {Built-in Function} {} isstreamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
82 Return true if @var{x} is a streamoff object. Otherwise, return\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
83 false.\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
84 @end deftypefn")
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
85 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
86 octave_value retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
87
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
88 if (args.length () == 1)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
89 retval = args(0).is_streamoff ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
90 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5781
diff changeset
91 print_usage ();
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
92
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
93 return retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
94 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
95
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
96 DEFUN (streamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
97 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
98 @deftypefn {Built-in Function} {} streamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
99 @deftypefnx {Built-in Function} {} streamoff (@var{n}, @var{m})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
100 Create a new streamoff array object. If invoked with a single scalar\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
101 argument, @code{streamoff} returns a square streamoff array with\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
102 the dimension specified. If you supply two scalar arguments,\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
103 @code{streamoff} takes them to be the number of rows and columns.\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
104 If given a vector with two elements, @code{streamoff} uses the values\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
105 of the elements as the number of rows and columns, respectively.\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
106 @end deftypefn")
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
107 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
108 octave_value retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
109
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
110 int nargin = args.length ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
111
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
112 dim_vector dims;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
113
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
114 switch (nargin)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
115 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
116 case 0:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
117 dims = dim_vector (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
118 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
119
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
120 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
121 get_dimensions (args(0), "streamoff", dims);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
122 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
123
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
124 default:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
125 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
126 dims.resize (nargin);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
127
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
128 for (int i = 0; i < nargin; i++)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
129 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
130 dims(i) = args(i).is_empty () ? 0 : args(i).nint_value ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
131
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
132 if (error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
133 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
134 error ("streamoff: expecting scalar arguments");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
135 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
136 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
137 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
138 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
139 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
140 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
141
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
142 if (! error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
143 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
144 int ndim = dims.length ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
145
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
146 check_dimensions (dims, "streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
147
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
148 if (! error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
149 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
150 switch (ndim)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
151 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
152 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
153 retval = Cell (dims(0), dims(0), Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
154 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
155
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
156 default:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
157 retval = Cell (dims, Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
158 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
159 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
160 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
161 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
162
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
163 return retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
164 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
165
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
166 /*
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
167 ;;; Local Variables: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
168 ;;; mode: C++ ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
169 ;;; End: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
170 */