annotate src/ov-streamoff.cc @ 5823:080c08b192d8

[project @ 2006-05-19 05:32:17 by jwe]
author jwe
date Fri, 19 May 2006 05:32:19 +0000
parents faafc2d98b8d
children 93c65f2a5668
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 {
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents: 5775
diff changeset
55 gripe_implicit_conversion ("Octave:array-as-scalar",
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents: 5775
diff changeset
56 "streamoff array", "scalar streamoff");
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
57
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
58 retval = matrix (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
59 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
60 else
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
61 gripe_invalid_conversion ("streamoff array", "scalar streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
62
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
63 return retval;
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
66 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
67 octave_streamoff::print (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
68 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
69 print_raw (os);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
70 newline (os);
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
73 void
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
74 octave_streamoff::print_raw (std::ostream& os, bool) const
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
75 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
76 dim_vector dv = matrix.dims ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
77 os << "<" << dv.str () << " streamoff object>";
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
80 DEFUN (isstreamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
81 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
82 @deftypefn {Built-in Function} {} isstreamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
83 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
84 false.\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
85 @end deftypefn")
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
86 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
87 octave_value retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
88
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
89 if (args.length () == 1)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
90 retval = args(0).is_streamoff ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
91 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5781
diff changeset
92 print_usage ();
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
93
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
94 return retval;
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
97 DEFUN (streamoff, args, ,
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
98 "-*- texinfo -*-\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
99 @deftypefn {Built-in Function} {} streamoff (@var{x})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
100 @deftypefnx {Built-in Function} {} streamoff (@var{n}, @var{m})\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
101 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
102 argument, @code{streamoff} returns a square streamoff array with\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
103 the dimension specified. If you supply two scalar arguments,\n\
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
104 @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
105 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
106 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
107 @end deftypefn")
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
108 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
109 octave_value retval;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
110
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
111 int nargin = args.length ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
112
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
113 dim_vector dims;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
114
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
115 switch (nargin)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
116 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
117 case 0:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
118 dims = dim_vector (0, 0);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
119 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
120
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
121 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
122 get_dimensions (args(0), "streamoff", dims);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
123 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
124
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
125 default:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
126 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
127 dims.resize (nargin);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
128
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
129 for (int i = 0; i < nargin; i++)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
130 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
131 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
132
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
133 if (error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
134 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
135 error ("streamoff: expecting scalar arguments");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
136 break;
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 }
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
140 break;
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
143 if (! error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
144 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
145 int ndim = dims.length ();
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
146
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
147 check_dimensions (dims, "streamoff");
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
148
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
149 if (! error_state)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
150 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
151 switch (ndim)
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
152 {
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
153 case 1:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
154 retval = Cell (dims(0), dims(0), Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
155 break;
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
156
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
157 default:
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
158 retval = Cell (dims, Matrix ());
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
159 break;
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
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
164 return retval;
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 /*
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
168 ;;; Local Variables: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
169 ;;; mode: C++ ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
170 ;;; End: ***
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents:
diff changeset
171 */