annotate src/ov-streamoff.cc @ 5536:f16c05db6250 ss-2-9-4

[project @ 2005-11-11 19:53:51 by jwe]
author jwe
date Fri, 11 Nov 2005 19:53:52 +0000
parents 4c8a2e4e0717
children ace8d8d26933
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 2003 John W. Eaton
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
10 later version.
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5105
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5105
diff changeset
20 02110-1301, USA.
4645
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
24 #ifdef HAVE_CONFIG_H
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
25 #include <config.h>
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
26 #endif
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
27
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
28 #include <iostream>
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
29
4646
eff8f977508c [project @ 2003-11-23 18:13:19 by jwe]
jwe
parents: 4645
diff changeset
30 #include "so-array.h"
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
31
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
32 #include "defun.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
33 #include "error.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
34 #include "gripes.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
35 #include "ov-streamoff.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
36 #include "oct-obj.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
37 #include "utils.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
38 #include "ov-base-mat.h"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
39 #include "ov-base-mat.cc"
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
40
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
41 template class octave_base_matrix<streamoff_array>;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
42
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
43 DEFINE_OCTAVE_ALLOCATOR (octave_streamoff);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
44
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
45 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_streamoff,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
46 "streamoff", "streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
47
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
48 std::streamoff
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
49 octave_streamoff::streamoff_value (void) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
50 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
51 std::streamoff retval (-1);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
52
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
53 if (numel () > 0)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
54 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
55 // XXX FIXME XXX -- is warn_fortran_indexing the right variable here?
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
56 if (Vwarn_fortran_indexing)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
57 gripe_implicit_conversion ("streamoff array", "scalar streamoff");
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 retval = matrix (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
60 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
61 else
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
62 gripe_invalid_conversion ("streamoff array", "scalar streamoff");
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 return retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
65 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
66
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
67 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
68 octave_streamoff::print (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
69 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
70 print_raw (os);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
71 newline (os);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
72 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
73
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
74 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
75 octave_streamoff::print_raw (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
76 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
77 dim_vector dv = matrix.dims ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
78 os << "<" << dv.str () << " streamoff object>";
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
79 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
80
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
81 DEFUN (isstreamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
82 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
83 @deftypefn {Built-in Function} {} isstreamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
84 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
85 false.\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
86 @end deftypefn")
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 octave_value retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
89
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
90 if (args.length () == 1)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
91 retval = args(0).is_streamoff ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
92 else
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
93 print_usage ("isstreamoff");
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 return retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
96 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
97
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
98 DEFUN (streamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
99 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
100 @deftypefn {Built-in Function} {} streamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
101 @deftypefnx {Built-in Function} {} streamoff (@var{n}, @var{m})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
102 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
103 argument, @code{streamoff} returns a square streamoff array with\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
104 the dimension specified. If you supply two scalar arguments,\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
105 @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
106 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
107 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
108 @end deftypefn")
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 octave_value retval;
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 int nargin = args.length ();
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 dim_vector dims;
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 switch (nargin)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
117 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
118 case 0:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
119 dims = dim_vector (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
120 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
121
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
122 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
123 get_dimensions (args(0), "streamoff", dims);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
124 break;
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 default:
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 dims.resize (nargin);
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 for (int i = 0; i < nargin; i++)
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 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
133
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
134 if (error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
135 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
136 error ("streamoff: expecting scalar arguments");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
137 break;
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 }
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 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
142 }
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 if (! error_state)
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 int ndim = dims.length ();
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 check_dimensions (dims, "streamoff");
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 if (! error_state)
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 switch (ndim)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
153 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
154 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
155 retval = Cell (dims(0), dims(0), Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
156 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
157
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
158 default:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
159 retval = Cell (dims, Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
160 break;
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 }
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 return retval;
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
168 /*
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
169 ;;; Local Variables: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
170 ;;; mode: C++ ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
171 ;;; End: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
172 */