octave: libinterp/octave-value/ov-struct.h annotate

annotate libinterp/octave-value/ov-struct.h @ 23446:cd4e1ee28716

maint: Use convention 'void * fcn ()' for functions which return pointers. * make_int.cc, dialog.h, file-editor-interface.h, file-editor-tab.h, file-editor.h, octave-txt-lexer.h, main-window.h, octave-dock-widget.h, parser.h, webinfo.h, resource-manager.h, thread-manager.h, c-file-ptr-stream.h, call-stack.h, comment-list.h, ft-text-renderer.h, gl-render.cc, input.h, mex.cc, mexproto.h, mxarray.in.h, oct-fstrm.h, oct-iostrm.h, oct-procbuf.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h, octave-link.h, sighandlers.cc, symtab.h, sysdep.h, utils.h, audiodevinfo.cc, ov-base-diag.h, ov-base-int.h, ov-base-scalar.h, ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h, ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h, ov-classdef.h, ov-colon.h, ov-complex.cc, ov-complex.h, ov-cs-list.h, ov-cx-diag.h, ov-cx-mat.h, ov-cx-sparse.h, ov-fcn-handle.h, ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h, ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h, ov-intx.h, ov-java.cc, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-oncleanup.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h, ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h, ov-usr-fcn.h, ov.h, octave.h, bp-table.h, jit-ir.h, jit-typeinfo.h, jit-util.h, lex.h, parse.h, pt-arg-list.h, pt-array-list.h, pt-assign.h, pt-binop.h, pt-cell.h, pt-classdef.h, pt-cmd.h, pt-colon.h, pt-const.h, pt-decl.h, pt-except.h, pt-exp.h, pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jit.h, pt-jump.h, pt-loop.h, pt-mat.h, pt-misc.h, pt-select.h, pt-stmt.h, pt-unop.h, token.h, Array.cc, Array.h, DiagArray2.h, Sparse.h, dim-vector.h, idx-vector.h, sparse-chol.cc, cmd-edit.cc, cmd-edit.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-array-gripes.cc, lo-utils.h, oct-inttypes.h, oct-locbuf.h, oct-refcount.h, oct-rl-edit.h, oct-rl-hist.h, oct-shlib.cc, oct-shlib.h, str-vec.h, canonicalize-file-name-wrapper.h, dirent-wrappers.h, getopt-wrapper.h, glob-wrappers.h, localcharset-wrapper.h, set-program-name-wrapper.h, signal-wrappers.h, strdup-wrapper.h, tmpfile-wrapper.h, unistd-wrappers.h, display-available.h: Use convention 'void * fcn ()' for functions which return pointers.

author	Rik <rik@octave.org>
date	Thu, 27 Apr 2017 09:48:57 -0700
parents	092078913d54
children	7ed6b258db91

rev	line source
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	1 /*
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 1996-2017 John W. Eaton
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	4
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	6
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	16
2142216bf85a [project @ 1996-10-12 01:39:07 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: 6974 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: 6974 diff changeset	19 <http://www.gnu.org/licenses/>.
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	20
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	21 */
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	22
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19863 diff changeset	23 #if ! defined (octave_ov_struct_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17787 diff changeset	24 #define octave_ov_struct_h 1
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	25
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	27
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	28 #include <cstdlib>
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	29
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	30 #include <iosfwd>
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	31 #include <string>
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	32
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	33 #include "mx-base.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	34 #include "str-vec.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	35
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	36 #include "error.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	37 #include "oct-map.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	38 #include "ov-base.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	39 #include "ov-typeinfo.h"
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	40
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	41 class octave_value_list;
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	42
2477 3d905d3820a4 [project @ 1996-11-07 16:46:11 by jwe] jwe parents: 2466 diff changeset	43 // Data structures.
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	44
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	45 class
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	46 octave_struct : public octave_base_value
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	47 {
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	48 public:
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	49
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	50 octave_struct (void)
11584 cda4aa780d58 Another round of initialising members in the constructor initialisation list Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11523 diff changeset	51 : octave_base_value (), map () { }
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	52
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	53 octave_struct (const octave_map& m)
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	54 : octave_base_value (), map (m) { }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	55
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	56 octave_struct (const octave_struct& s)
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	57 : octave_base_value (), map (s.map) { }
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	58
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	59 ~octave_struct (void) = default;
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	60
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	61 octave_base_value * clone (void) const { return new octave_struct (*this); }
cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	62 octave_base_value * empty_clone (void) const { return new octave_struct (); }
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3523 diff changeset	63
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	64 octave_base_value * try_narrowing_conversion (void);
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	65
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	66 Cell dotref (const octave_value_list& idx, bool auto_add = false);
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	67
7651 443a8f5a50fd require both subsref variants to be defined in octave_value subclasses John W. Eaton <jwe@octave.org> parents: 7622 diff changeset	68 octave_value subsref (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	69 const std::list<octave_value_list>& idx)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	70 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	71 octave_value_list tmp = subsref (type, idx, 1);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	72 return tmp.length () > 0 ? tmp(0) : octave_value ();
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	73 }
7622 c195bd0a5c64 treat structs and cells as "constants" John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	74
c195bd0a5c64 treat structs and cells as "constants" John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	75 octave_value_list subsref (const std::string&,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	76 const std::list<octave_value_list>&, int);
4994 48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe] jwe parents: 4936 diff changeset	77
8551 906f976d35a8 further improve struct&cell indexing & indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 8546 diff changeset	78 octave_value subsref (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	79 const std::list<octave_value_list>& idx,
8551 906f976d35a8 further improve struct&cell indexing & indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 8546 diff changeset	80 bool auto_add);
906f976d35a8 further improve struct&cell indexing & indexed assignment Jaroslav Hajek <highegg@gmail.com> parents: 8546 diff changeset	81
8546 3d8a914c580e improve parser indexed assigment code Jaroslav Hajek <highegg@gmail.com> parents: 7651 diff changeset	82 static octave_value numeric_conv (const octave_value& val,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	83 const std::string& type);
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	84
4247 fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe] jwe parents: 4219 diff changeset	85 octave_value subsasgn (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	86 const std::list<octave_value_list>& idx,
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	87 const octave_value& rhs);
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	88
7046 fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	89 octave_value squeeze (void) const { return map.squeeze (); }
fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	90
fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	91 octave_value permute (const Array<int>& vec, bool inv = false) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	92 { return map.permute (vec, inv); }
7046 fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	93
fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	94 octave_value do_index_op (const octave_value_list& idx,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	95 bool resize_ok = false);
7046 fbf8576cf399 [project @ 2007-10-22 12:12:20 by dbateman] dbateman parents: 7017 diff changeset	96
4563 742993a501b9 [project @ 2003-10-29 06:25:12 by jwe] jwe parents: 4513 diff changeset	97 dim_vector dims (void) const { return map.dims (); }
4200 1f04df06e1a6 [project @ 2002-11-22 16:25:49 by jwe] jwe parents: 4192 diff changeset	98
4791 62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe] jwe parents: 4687 diff changeset	99 size_t byte_size (void) const;
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe] jwe parents: 4687 diff changeset	100
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	101 // This is the number of elements in each field. The total number
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	102 // of elements is numel () * nfields ().
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	103 octave_idx_type numel (void) const
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	104 {
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	105 return map.numel ();
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	106 }
c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	107
6639 ed74670db09b [project @ 2007-05-21 19:47:22 by jwe] jwe parents: 5958 diff changeset	108 octave_idx_type nfields (void) const { return map.nfields (); }
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	109
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4563 diff changeset	110 octave_value reshape (const dim_vector& new_dims) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	111 { return map.reshape (new_dims); }
4567 fc30061d01da [project @ 2003-10-29 20:11:15 by jwe] jwe parents: 4563 diff changeset	112
10754 92eb5fb58ebc fix resize with structs Jaroslav Hajek <highegg@gmail.com> parents: 10742 diff changeset	113 octave_value resize (const dim_vector& dv, bool fill = false) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	114 { octave_map tmap = map; tmap.resize (dv, fill); return tmap; }
4936 e63617efbd3f [project @ 2004-08-06 16:18:17 by jwe] jwe parents: 4791 diff changeset	115
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	116 bool is_defined (void) const { return true; }
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	117
7622 c195bd0a5c64 treat structs and cells as "constants" John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	118 bool is_constant (void) const { return true; }
c195bd0a5c64 treat structs and cells as "constants" John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	119
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	120 bool is_map (void) const { return true; }
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	121
10087 090173f2db40 improve overload dispatching of built-in classes Jaroslav Hajek <highegg@gmail.com> parents: 9881 diff changeset	122 builtin_type_t builtin_type (void) const { return btyp_struct; }
090173f2db40 improve overload dispatching of built-in classes Jaroslav Hajek <highegg@gmail.com> parents: 9881 diff changeset	123
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	124 octave_map map_value (void) const { return map; }
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	125
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	126 string_vector map_keys (void) const { return map.fieldnames (); }
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3523 diff changeset	127
18416 bcd71a2531d3 Support disp/display overloading in classdef Michael Goffioul <michael.goffioul@gmail.com> parents: 17822 diff changeset	128 void print (std::ostream& os, bool pr_as_read_syntax = false);
2901 e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe] jwe parents: 2847 diff changeset	129
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	130 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
2901 e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe] jwe parents: 2847 diff changeset	131
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	132 bool print_name_tag (std::ostream& os, const std::string& name) const;
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	133
6974 9e32bb109980 [project @ 2007-10-08 11:06:47 by jwe] jwe parents: 6639 diff changeset	134 bool save_ascii (std::ostream& os);
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	135
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	136 bool load_ascii (std::istream& is);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	137
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	138 bool save_binary (std::ostream& os, bool& save_as_floats);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	139
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	140 bool load_binary (std::istream& is, bool swap,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	141 octave::mach_info::float_format fmt);
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	142
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	143 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	144
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	145 bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4661 diff changeset	146
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	147 mxArray * as_mxArray (void) const;
5900 c20eb7330d13 [project @ 2006-07-22 08:31:16 by jwe] jwe parents: 5888 diff changeset	148
10760 76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	149 octave_value
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	150 fast_elem_extract (octave_idx_type n) const;
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	151
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	152 bool
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	153 fast_elem_insert (octave_idx_type n, const octave_value& x);
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	154
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7046 diff changeset	155 protected:
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	156
2477 3d905d3820a4 [project @ 1996-11-07 16:46:11 by jwe] jwe parents: 2466 diff changeset	157 // The associative array used to manage the structure data.
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	158 octave_map map;
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	159
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7046 diff changeset	160 private:
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7046 diff changeset	161
3219 30770ba4457a [project @ 1998-11-13 03:44:31 by jwe] jwe parents: 2979 diff changeset	162 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
2376 2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	163 };
2142216bf85a [project @ 1996-10-12 01:39:07 by jwe] jwe parents: diff changeset	164
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	165 class
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	166 octave_scalar_struct : public octave_base_value
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	167 {
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	168 public:
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	169
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	170 octave_scalar_struct (void)
11584 cda4aa780d58 Another round of initialising members in the constructor initialisation list Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11523 diff changeset	171 : octave_base_value (), map () { }
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	172
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	173 octave_scalar_struct (const octave_scalar_map& m)
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	174 : octave_base_value (), map (m) { }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	175
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	176 octave_scalar_struct (const octave_scalar_struct& s)
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	177 : octave_base_value (), map (s.map) { }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	178
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	179 ~octave_scalar_struct (void) = default;
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	180
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	181 octave_base_value * clone (void) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	182 { return new octave_scalar_struct (*this); }
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	183 octave_base_value * empty_clone (void) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	184 { return new octave_scalar_struct (); }
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	185
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	186 octave_value dotref (const octave_value_list& idx, bool auto_add = false);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	187
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	188 octave_value subsref (const std::string& type,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	189 const std::list<octave_value_list>& idx);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	190
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	191 octave_value_list subsref (const std::string& type,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	192 const std::list<octave_value_list>& idx, int);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	193
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	194 octave_value subsref (const std::string& type,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	195 const std::list<octave_value_list>& idx,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	196 bool auto_add);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	197
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	198 static octave_value numeric_conv (const octave_value& val,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	199 const std::string& type);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	200
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	201 octave_value subsasgn (const std::string& type,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	202 const std::list<octave_value_list>& idx,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	203 const octave_value& rhs);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	204
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	205 octave_value squeeze (void) const { return map; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	206
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	207 octave_value permute (const Array<int>& vec, bool inv = false) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	208 { return octave_map (map).permute (vec, inv); }
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	209
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	210 octave_value do_index_op (const octave_value_list& idx,
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	211 bool resize_ok = false);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	212
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	213 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	214
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	215 size_t byte_size (void) const;
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	216
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	217 // This is the number of elements in each field. The total number
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	218 // of elements is numel () * nfields ().
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	219 octave_idx_type numel (void) const
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	220 {
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	221 return 1;
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	222 }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	223
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	224 octave_idx_type nfields (void) const { return map.nfields (); }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	225
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	226 octave_value reshape (const dim_vector& new_dims) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	227 { return octave_map (map).reshape (new_dims); }
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	228
10754 92eb5fb58ebc fix resize with structs Jaroslav Hajek <highegg@gmail.com> parents: 10742 diff changeset	229 octave_value resize (const dim_vector& dv, bool fill = false) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	230 { octave_map tmap = map; tmap.resize (dv, fill); return tmap; }
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	231
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	232 bool is_defined (void) const { return true; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	233
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	234 bool is_constant (void) const { return true; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	235
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	236 bool is_map (void) const { return true; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	237
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	238 builtin_type_t builtin_type (void) const { return btyp_struct; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	239
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	240 octave_map map_value (void) const { return map; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	241
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	242 octave_scalar_map scalar_map_value (void) const { return map; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	243
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	244 string_vector map_keys (void) const { return map.fieldnames (); }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	245
18416 bcd71a2531d3 Support disp/display overloading in classdef Michael Goffioul <michael.goffioul@gmail.com> parents: 17822 diff changeset	246 void print (std::ostream& os, bool pr_as_read_syntax = false);
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	247
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	248 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	249
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	250 bool print_name_tag (std::ostream& os, const std::string& name) const;
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	251
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	252 bool save_ascii (std::ostream& os);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	253
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	254 bool load_ascii (std::istream& is);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	255
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	256 bool save_binary (std::ostream& os, bool& save_as_floats);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	257
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	258 bool load_binary (std::istream& is, bool swap,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	259 octave::mach_info::float_format fmt);
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	260
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	261 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	262
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	263 bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	264
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	265 mxArray * as_mxArray (void) const;
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	266
10760 76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	267 bool fast_elem_insert_self (void *where, builtin_type_t btyp) const;
76079e505f9d optimize cellfun with uniform struct output Jaroslav Hajek <highegg@gmail.com> parents: 10754 diff changeset	268
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	269 protected:
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	270
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	271 // The associative array used to manage the structure data.
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	272 octave_scalar_map map;
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	273
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	274 private:
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	275
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	276 octave_value to_array (void);
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	277
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	278 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	279 };
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	280
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	281 #endif

Mercurial > octave

annotate libinterp/octave-value/ov-struct.h @ 23446:cd4e1ee28716