Mercurial > octave-nkf
view libinterp/corefcn/oct-map.h @ 17787:175b392e91fe
Use GNU style coding conventions for code in libinterp/
* libinterp/corefcn/Cell.h, libinterp/corefcn/__contourc__.cc,
libinterp/corefcn/__dispatch__.cc, libinterp/corefcn/__lin_interpn__.cc,
libinterp/corefcn/__pchip_deriv__.cc, libinterp/corefcn/__qp__.cc,
libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc,
libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc,
libinterp/corefcn/bsxfun.cc, libinterp/corefcn/c-file-ptr-stream.cc,
libinterp/corefcn/c-file-ptr-stream.h, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/colloc.cc, libinterp/corefcn/comment-list.h,
libinterp/corefcn/conv2.cc, libinterp/corefcn/daspk.cc,
libinterp/corefcn/dasrt.cc, libinterp/corefcn/dassl.cc,
libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc,
libinterp/corefcn/defaults.cc, libinterp/corefcn/defaults.in.h,
libinterp/corefcn/defun-int.h, libinterp/corefcn/defun.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/display.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/dot.cc, libinterp/corefcn/dynamic-ld.cc,
libinterp/corefcn/dynamic-ld.h, libinterp/corefcn/eig.cc,
libinterp/corefcn/ellipj.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/error.h, libinterp/corefcn/event-queue.h,
libinterp/corefcn/fft.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/givens.cc, libinterp/corefcn/gl-render.cc,
libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/gl2ps-renderer.h,
libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h,
libinterp/corefcn/gripes.cc, libinterp/corefcn/gripes.h,
libinterp/corefcn/help.cc, libinterp/corefcn/hess.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/input.h, libinterp/corefcn/inv.cc,
libinterp/corefcn/jit-ir.h, libinterp/corefcn/jit-typeinfo.cc,
libinterp/corefcn/jit-typeinfo.h, libinterp/corefcn/jit-util.h,
libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc,
libinterp/corefcn/load-path.h, libinterp/corefcn/load-save.cc,
libinterp/corefcn/load-save.h, libinterp/corefcn/lookup.cc,
libinterp/corefcn/ls-ascii-helper.cc, libinterp/corefcn/ls-hdf5.cc,
libinterp/corefcn/ls-hdf5.h, libinterp/corefcn/ls-mat-ascii.cc,
libinterp/corefcn/ls-mat-ascii.h, libinterp/corefcn/ls-mat4.cc,
libinterp/corefcn/ls-mat5.cc, libinterp/corefcn/ls-mat5.h,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc,
libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc,
libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc,
libinterp/corefcn/mex.cc, libinterp/corefcn/mexproto.h,
libinterp/corefcn/mgorth.cc, libinterp/corefcn/mxarray.in.h,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/oct-lvalue.h, libinterp/corefcn/oct-map.cc,
libinterp/corefcn/oct-map.h, libinterp/corefcn/oct-obj.h,
libinterp/corefcn/oct-prcstrm.h, libinterp/corefcn/oct-stdstrm.h,
libinterp/corefcn/oct-stream.cc, libinterp/corefcn/oct-stream.h,
libinterp/corefcn/octave-link.cc, libinterp/corefcn/octave-link.h,
libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/procstream.h,
libinterp/corefcn/profiler.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/pt-jit.h, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sighandlers.h,
libinterp/corefcn/sparse-xdiv.cc, libinterp/corefcn/sparse-xdiv.h,
libinterp/corefcn/sparse-xpow.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/sqrtm.cc,
libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc,
libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/syl.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/symtab.h,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc,
libinterp/corefcn/sysdep.h, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/toplev.h,
libinterp/corefcn/tril.cc, libinterp/corefcn/txt-eng-ft.cc,
libinterp/corefcn/txt-eng-ft.h, libinterp/corefcn/txt-eng.h,
libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/corefcn/variables.h, libinterp/corefcn/xdiv.cc,
libinterp/corefcn/xdiv.h, libinterp/corefcn/xnorm.h, libinterp/corefcn/xpow.cc,
libinterp/corefcn/xpow.h, libinterp/corefcn/zfstream.cc,
libinterp/corefcn/zfstream.h, libinterp/dldfcn/__delaunayn__.cc,
libinterp/dldfcn/__dsearchn__.cc, libinterp/dldfcn/__eigs__.cc,
libinterp/dldfcn/__fltk_uigetfile__.cc, libinterp/dldfcn/__glpk__.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/__init_gnuplot__.cc,
libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/__voronoi__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc,
libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc,
libinterp/dldfcn/tsearch.cc, libinterp/octave-value/ov-base-diag.cc,
libinterp/octave-value/ov-base-diag.h, libinterp/octave-value/ov-base-int.cc,
libinterp/octave-value/ov-base-int.h, libinterp/octave-value/ov-base-mat.h,
libinterp/octave-value/ov-base-scalar.cc,
libinterp/octave-value/ov-base-scalar.h,
libinterp/octave-value/ov-base-sparse.cc,
libinterp/octave-value/ov-base-sparse.h, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-base.h, libinterp/octave-value/ov-bool-mat.cc,
libinterp/octave-value/ov-bool-mat.h, libinterp/octave-value/ov-bool-sparse.cc,
libinterp/octave-value/ov-bool-sparse.h, libinterp/octave-value/ov-bool.cc,
libinterp/octave-value/ov-bool.h, libinterp/octave-value/ov-builtin.cc,
libinterp/octave-value/ov-builtin.h, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-cell.h, libinterp/octave-value/ov-ch-mat.cc,
libinterp/octave-value/ov-ch-mat.h, libinterp/octave-value/ov-class.cc,
libinterp/octave-value/ov-class.h, libinterp/octave-value/ov-colon.h,
libinterp/octave-value/ov-complex.cc, libinterp/octave-value/ov-complex.h,
libinterp/octave-value/ov-cx-diag.cc, libinterp/octave-value/ov-cx-diag.h,
libinterp/octave-value/ov-cx-mat.cc, libinterp/octave-value/ov-cx-mat.h,
libinterp/octave-value/ov-cx-sparse.cc, libinterp/octave-value/ov-cx-sparse.h,
libinterp/octave-value/ov-dld-fcn.h, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-handle.h,
libinterp/octave-value/ov-fcn-inline.cc,
libinterp/octave-value/ov-fcn-inline.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-float.cc, libinterp/octave-value/ov-float.h,
libinterp/octave-value/ov-flt-complex.cc,
libinterp/octave-value/ov-flt-complex.h,
libinterp/octave-value/ov-flt-cx-diag.cc,
libinterp/octave-value/ov-flt-cx-diag.h,
libinterp/octave-value/ov-flt-cx-mat.cc,
libinterp/octave-value/ov-flt-cx-mat.h,
libinterp/octave-value/ov-flt-re-diag.cc,
libinterp/octave-value/ov-flt-re-diag.h,
libinterp/octave-value/ov-flt-re-mat.cc,
libinterp/octave-value/ov-flt-re-mat.h, libinterp/octave-value/ov-int16.cc,
libinterp/octave-value/ov-int32.cc, libinterp/octave-value/ov-int64.cc,
libinterp/octave-value/ov-int8.cc, libinterp/octave-value/ov-intx.h,
libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-lazy-idx.h,
libinterp/octave-value/ov-mex-fcn.cc, libinterp/octave-value/ov-mex-fcn.h,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-null-mat.h,
libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-perm.cc,
libinterp/octave-value/ov-perm.h, libinterp/octave-value/ov-range.cc,
libinterp/octave-value/ov-range.h, libinterp/octave-value/ov-re-diag.cc,
libinterp/octave-value/ov-re-diag.h, libinterp/octave-value/ov-re-mat.cc,
libinterp/octave-value/ov-re-mat.h, libinterp/octave-value/ov-re-sparse.cc,
libinterp/octave-value/ov-re-sparse.h, libinterp/octave-value/ov-scalar.cc,
libinterp/octave-value/ov-scalar.h, libinterp/octave-value/ov-str-mat.cc,
libinterp/octave-value/ov-str-mat.h, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-struct.h, libinterp/octave-value/ov-type-conv.h,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-typeinfo.h,
libinterp/octave-value/ov-uint16.cc, libinterp/octave-value/ov-uint32.cc,
libinterp/octave-value/ov-uint64.cc, libinterp/octave-value/ov-uint8.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov-usr-fcn.h,
libinterp/octave-value/ov.cc, libinterp/octave-value/ov.h, libinterp/octave.cc,
libinterp/operators/op-b-bm.cc, libinterp/operators/op-b-sbm.cc,
libinterp/operators/op-bm-b.cc, libinterp/operators/op-bm-bm.cc,
libinterp/operators/op-cdm-cdm.cc, libinterp/operators/op-chm.cc,
libinterp/operators/op-class.cc, libinterp/operators/op-cm-cm.cc,
libinterp/operators/op-cm-cs.cc, libinterp/operators/op-cm-s.cc,
libinterp/operators/op-cm-scm.cc, libinterp/operators/op-cm-sm.cc,
libinterp/operators/op-cs-cm.cc, libinterp/operators/op-cs-cs.cc,
libinterp/operators/op-cs-scm.cc, libinterp/operators/op-cs-sm.cc,
libinterp/operators/op-dm-dm.cc, libinterp/operators/op-dm-scm.cc,
libinterp/operators/op-double-conv.cc, libinterp/operators/op-fcdm-fcdm.cc,
libinterp/operators/op-fcm-fcm.cc, libinterp/operators/op-fcm-fcs.cc,
libinterp/operators/op-fcm-fm.cc, libinterp/operators/op-fcm-fs.cc,
libinterp/operators/op-fcs-fcm.cc, libinterp/operators/op-fcs-fcs.cc,
libinterp/operators/op-fcs-fm.cc, libinterp/operators/op-fcs-fs.cc,
libinterp/operators/op-fdm-fdm.cc, libinterp/operators/op-float-conv.cc,
libinterp/operators/op-fm-fcm.cc, libinterp/operators/op-fm-fcs.cc,
libinterp/operators/op-fm-fm.cc, libinterp/operators/op-fm-fs.cc,
libinterp/operators/op-fs-fcm.cc, libinterp/operators/op-fs-fcs.cc,
libinterp/operators/op-fs-fm.cc, libinterp/operators/op-fs-fs.cc,
libinterp/operators/op-m-cm.cc, libinterp/operators/op-m-cs.cc,
libinterp/operators/op-m-m.cc, libinterp/operators/op-m-s.cc,
libinterp/operators/op-m-scm.cc, libinterp/operators/op-m-sm.cc,
libinterp/operators/op-pm-scm.cc, libinterp/operators/op-range.cc,
libinterp/operators/op-s-cm.cc, libinterp/operators/op-s-cs.cc,
libinterp/operators/op-s-scm.cc, libinterp/operators/op-sbm-b.cc,
libinterp/operators/op-sbm-bm.cc, libinterp/operators/op-sbm-sbm.cc,
libinterp/operators/op-scm-cm.cc, libinterp/operators/op-scm-cs.cc,
libinterp/operators/op-scm-m.cc, libinterp/operators/op-scm-s.cc,
libinterp/operators/op-scm-scm.cc, libinterp/operators/op-scm-sm.cc,
libinterp/operators/op-sm-cm.cc, libinterp/operators/op-sm-m.cc,
libinterp/operators/op-sm-s.cc, libinterp/operators/op-sm-scm.cc,
libinterp/operators/op-sm-sm.cc, libinterp/operators/op-str-m.cc,
libinterp/operators/op-str-s.cc, libinterp/operators/op-str-str.cc,
libinterp/operators/ops.h, libinterp/parse-tree/lex.h,
libinterp/parse-tree/parse.h, libinterp/parse-tree/pt-arg-list.cc,
libinterp/parse-tree/pt-arg-list.h, libinterp/parse-tree/pt-assign.cc,
libinterp/parse-tree/pt-assign.h, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-binop.h, libinterp/parse-tree/pt-bp.h,
libinterp/parse-tree/pt-cbinop.cc, libinterp/parse-tree/pt-check.cc,
libinterp/parse-tree/pt-colon.cc, libinterp/parse-tree/pt-colon.h,
libinterp/parse-tree/pt-const.cc, libinterp/parse-tree/pt-decl.cc,
libinterp/parse-tree/pt-decl.h, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-except.h, libinterp/parse-tree/pt-exp.h,
libinterp/parse-tree/pt-fcn-handle.cc, libinterp/parse-tree/pt-id.cc,
libinterp/parse-tree/pt-id.h, libinterp/parse-tree/pt-idx.cc,
libinterp/parse-tree/pt-idx.h, libinterp/parse-tree/pt-loop.h,
libinterp/parse-tree/pt-mat.cc, libinterp/parse-tree/pt-misc.cc,
libinterp/parse-tree/pt-misc.h, libinterp/parse-tree/pt-pr-code.cc,
libinterp/parse-tree/pt-select.h, libinterp/parse-tree/pt-stmt.h,
libinterp/parse-tree/token.h, libinterp/version.cc:
Use GNU style coding conventions for code in libinterp/
author | Rik <rik@octave.org> |
---|---|
date | Mon, 28 Oct 2013 19:51:46 -0700 |
parents | d63878346099 |
children | 4c064d3d2750 |
line wrap: on
line source
/* Copyright (C) 1994-2013 John W. Eaton Copyright (C) 2010 VZLU Prague This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if !defined (octave_oct_map_h) #define octave_oct_map_h 1 #include <algorithm> #include <map> #include "Cell.h" #include "oct-obj.h" class string_vector; // A class holding a map field->index. Supports reference-counting. class OCTINTERP_API octave_fields { class fields_rep : public std::map<std::string, octave_idx_type> { public: fields_rep (void) : std::map<std::string, octave_idx_type> (), count (1) { } fields_rep (const fields_rep& other) : std::map<std::string, octave_idx_type> (other), count (1) { } octave_refcount<int> count; private: fields_rep& operator = (const fields_rep&); // no assignment! }; fields_rep *rep; static fields_rep *nil_rep (void) { static fields_rep nr; return &nr; } public: octave_fields (void) : rep (nil_rep ()) { rep->count++; } octave_fields (const string_vector&); octave_fields (const char * const *); ~octave_fields (void) { if (--rep->count == 0) delete rep; } void make_unique (void) { if (rep->count > 1) { fields_rep *r = new fields_rep (*rep); if (--rep->count == 0) delete rep; rep = r; } } octave_fields (const octave_fields& o) : rep (o.rep) { rep->count++; } octave_fields& operator = (const octave_fields& o) { o.rep->count++; if (--rep->count == 0) delete rep; rep = o.rep; return *this; } // constant iteration support. non-const iteration intentionally unsupported. typedef std::map<std::string, octave_idx_type>::const_iterator const_iterator; typedef const_iterator iterator; const_iterator begin (void) const { return rep->begin (); } const_iterator end (void) const { return rep->end (); } std::string key (const_iterator p) const { return p->first; } octave_idx_type index (const_iterator p) const { return p->second; } const_iterator seek (const std::string& k) const { return rep->find (k); } // high-level methods. // number of fields. octave_idx_type nfields (void) const { return rep->size (); } // check whether a field exists. bool isfield (const std::string& name) const; // get index of field. return -1 if not exist octave_idx_type getfield (const std::string& name) const; // get index of field. add if not exist octave_idx_type getfield (const std::string& name); // remove field and return the index. -1 if didn't exist. octave_idx_type rmfield (const std::string& name); // order the fields of this map. creates a permutation // used to order the fields. void orderfields (Array<octave_idx_type>& perm); // compares two instances for equality up to order of fields. // returns a permutation needed to bring the fields of *other* // into the order of *this*. bool equal_up_to_order (const octave_fields& other, octave_idx_type* perm) const; bool equal_up_to_order (const octave_fields& other, Array<octave_idx_type>& perm) const; bool is_same (const octave_fields& other) const { return rep == other.rep; } // Returns the fields as a vector of strings. string_vector fieldnames (void) const; void clear (void) { *this = octave_fields (); } }; class OCTINTERP_API octave_scalar_map { public: octave_scalar_map (const octave_fields& k) : xkeys (k), xvals (k.nfields ()) { } octave_scalar_map (void) : xkeys (), xvals () { } octave_scalar_map (const string_vector& k) : xkeys (k), xvals (k.length ()) { } octave_scalar_map (const octave_scalar_map& m) : xkeys (m.xkeys), xvals(m.xvals) { } octave_scalar_map& operator = (const octave_scalar_map& m) { xkeys = m.xkeys; xvals = m.xvals; return *this; } // iteration support. note that both const and non-const iterators are the // same. The const/non-const distinction is made by the key & contents method. typedef octave_fields::const_iterator const_iterator; typedef const_iterator iterator; const_iterator begin (void) const { return xkeys.begin (); } const_iterator end (void) const { return xkeys.end (); } const_iterator seek (const std::string& k) const { return xkeys.seek (k); } std::string key (const_iterator p) const { return xkeys.key (p); } octave_idx_type index (const_iterator p) const { return xkeys.index (p); } const octave_value& contents (const_iterator p) const { return xvals[xkeys.index (p)]; } octave_value& contents (iterator p) { return xvals[xkeys.index (p)]; } const octave_value& contents (octave_idx_type i) const { return xvals[i]; } octave_value& contents (octave_idx_type i) { return xvals[i]; } // number of fields. octave_idx_type nfields (void) const { return xkeys.nfields (); } // check whether a field exists. bool isfield (const std::string& name) const { return xkeys.isfield (name); } bool contains (const std::string& name) const { return isfield (name); } string_vector fieldnames (void) const { return xkeys.fieldnames (); } string_vector keys (void) const { return fieldnames (); } // get contents of a given field. empty value if not exist. octave_value getfield (const std::string& key) const; // set contents of a given field. add if not exist. void setfield (const std::string& key, const octave_value& val); void assign (const std::string& k, const octave_value& val) { setfield (k, val); } // remove a given field. do nothing if not exist. void rmfield (const std::string& key); void del (const std::string& k) { rmfield (k); } // return a copy with fields ordered, optionally along with permutation. octave_scalar_map orderfields (void) const; octave_scalar_map orderfields (Array<octave_idx_type>& perm) const; octave_scalar_map orderfields (const octave_scalar_map& other, Array<octave_idx_type>& perm) const; // aka getfield/setfield, but the latter returns a reference. octave_value contents (const std::string& k) const; octave_value& contents (const std::string& k); void clear (void) { xkeys.clear (); xvals.clear (); } friend class octave_map; private: octave_fields xkeys; std::vector<octave_value> xvals; }; template<> inline octave_scalar_map octave_value_extract<octave_scalar_map> (const octave_value& v) { return v.scalar_map_value (); } class OCTINTERP_API octave_map { public: octave_map (const octave_fields& k) : xkeys (k), xvals (k.nfields ()), dimensions () { } octave_map (const dim_vector& dv, const octave_fields& k) : xkeys (k), xvals (k.nfields (), Cell (dv)), dimensions (dv) { } typedef octave_scalar_map element_type; octave_map (void) : xkeys (), xvals (), dimensions () { } octave_map (const dim_vector& dv) : xkeys (), xvals (), dimensions (dv) { } octave_map (const string_vector& k) : xkeys (k), xvals (k.length (), Cell (1, 1)), dimensions (1, 1) { } octave_map (const dim_vector& dv, const string_vector& k) : xkeys (k), xvals (k.length (), Cell (dv)), dimensions (dv) { } octave_map (const octave_map& m) : xkeys (m.xkeys), xvals (m.xvals), dimensions (m.dimensions) { } octave_map (const octave_scalar_map& m); octave_map (const Octave_map& m); octave_map& operator = (const octave_map& m) { xkeys = m.xkeys; xvals = m.xvals; dimensions = m.dimensions; return *this; } // iteration support. note that both const and non-const iterators are the // same. The const/non-const distinction is made by the key & contents method. typedef octave_fields::const_iterator const_iterator; typedef const_iterator iterator; const_iterator begin (void) const { return xkeys.begin (); } const_iterator end (void) const { return xkeys.end (); } const_iterator seek (const std::string& k) const { return xkeys.seek (k); } std::string key (const_iterator p) const { return xkeys.key (p); } octave_idx_type index (const_iterator p) const { return xkeys.index (p); } const Cell& contents (const_iterator p) const { return xvals[xkeys.index (p)]; } Cell& contents (iterator p) { return xvals[xkeys.index (p)]; } const Cell& contents (octave_idx_type i) const { return xvals[i]; } Cell& contents (octave_idx_type i) { return xvals[i]; } // number of fields. octave_idx_type nfields (void) const { return xkeys.nfields (); } // check whether a field exists. bool isfield (const std::string& name) const { return xkeys.isfield (name); } bool contains (const std::string& name) const { return isfield (name); } string_vector fieldnames (void) const { return xkeys.fieldnames (); } string_vector keys (void) const { return fieldnames (); } // get contents of a given field. empty value if not exist. Cell getfield (const std::string& key) const; // set contents of a given field. add if not exist. checks for // correct dimensions. void setfield (const std::string& key, const Cell& val); void assign (const std::string& k, const Cell& val) { setfield (k, val); } // remove a given field. do nothing if not exist. void rmfield (const std::string& key); void del (const std::string& k) { rmfield (k); } // return a copy with fields ordered, optionally along with permutation. octave_map orderfields (void) const; octave_map orderfields (Array<octave_idx_type>& perm) const; octave_map orderfields (const octave_map& other, Array<octave_idx_type>& perm) const; // aka getfield/setfield, but the latter returns a reference. Cell contents (const std::string& k) const; Cell& contents (const std::string& k); void clear (void) { xkeys.clear (); xvals.clear (); } // The Array-like methods. octave_idx_type numel (void) const { return dimensions.numel (); } octave_idx_type length (void) const { return numel (); } bool is_empty (void) const { return dimensions.any_zero (); } octave_idx_type rows (void) const { return dimensions(0); } octave_idx_type cols (void) const { return dimensions(1); } octave_idx_type columns (void) const { return dimensions(1); } // Extract a scalar substructure. octave_scalar_map checkelem (octave_idx_type n) const; octave_scalar_map checkelem (octave_idx_type i, octave_idx_type j) const; octave_scalar_map checkelem (const Array<octave_idx_type>& ra_idx) const; octave_scalar_map operator () (octave_idx_type n) const { return checkelem (n); } octave_scalar_map operator () (octave_idx_type i, octave_idx_type j) const { return checkelem (i, j); } octave_scalar_map operator () (const Array<octave_idx_type>& ra_idx) const { return checkelem (ra_idx); } octave_map squeeze (void) const; octave_map permute (const Array<int>& vec, bool inv = false) const; dim_vector dims (void) const { return dimensions; } int ndims (void) const { return dimensions.length (); } octave_map transpose (void) const; octave_map reshape (const dim_vector& dv) const; void resize (const dim_vector& dv, bool fill = false); static octave_map cat (int dim, octave_idx_type n, const octave_scalar_map *map_list); static octave_map cat (int dim, octave_idx_type n, const octave_map *map_list); octave_map index (const idx_vector& i, bool resize_ok = false) const; octave_map index (const idx_vector& i, const idx_vector& j, bool resize_ok = false) const; octave_map index (const Array<idx_vector>& ia, bool resize_ok = false) const; octave_map index (const octave_value_list&, bool resize_ok = false) const; octave_map column (octave_idx_type k) const; octave_map page (octave_idx_type k) const; void assign (const idx_vector& i, const octave_map& rhs); void assign (const idx_vector& i, const idx_vector& j, const octave_map& rhs); void assign (const Array<idx_vector>& ia, const octave_map& rhs); void assign (const octave_value_list&, const octave_map& rhs); void assign (const octave_value_list& idx, const std::string& k, const Cell& rhs); void delete_elements (const idx_vector& i); void delete_elements (int dim, const idx_vector& i); void delete_elements (const Array<idx_vector>& ia); void delete_elements (const octave_value_list&); octave_map concat (const octave_map& rb, const Array<octave_idx_type>& ra_idx); // like checkelem, but no check. octave_scalar_map fast_elem_extract (octave_idx_type n) const; // element assignment, no bounds check bool fast_elem_insert (octave_idx_type n, const octave_scalar_map& rhs); private: octave_fields xkeys; std::vector<Cell> xvals; dim_vector dimensions; void optimize_dimensions (void); void extract_scalar (octave_scalar_map& dest, octave_idx_type index) const; static void do_cat (int dim, octave_idx_type n, const octave_scalar_map *map_list, octave_map& retval); static void do_cat (int dim, octave_idx_type n, const octave_map *map_list, octave_map& retval); }; template<> inline octave_map octave_value_extract<octave_map> (const octave_value& v) { return v.map_value (); } // The original Octave_map object which is now deprecated. // It was fully deprecated in version 3.8 and should be removed in 3.12. // Octave_map and octave_map are convertible to each other. class OCTINTERP_API Octave_map { public: typedef std::map<std::string, Cell>::iterator iterator; typedef std::map<std::string, Cell>::const_iterator const_iterator; typedef std::list<std::string>::iterator key_list_iterator; typedef std::list<std::string>::const_iterator const_key_list_iterator; // Warning! You should always use at least two dimensions. Octave_map (const dim_vector& dv = dim_vector (0, 0), const Cell& key_vals = Cell ()); Octave_map (const std::string& k, const octave_value& value) : map (), key_list (), dimensions (1, 1) { map[k] = value; key_list.push_back (k); } Octave_map (const string_vector& sv, const dim_vector& dv = dim_vector (0, 0)) : map (), key_list (), dimensions (dv) { for (octave_idx_type i = 0; i < sv.length (); i++) { std::string k = sv[i]; map[k] = Cell (dv); key_list.push_back (k); } } Octave_map (const std::string& k, const Cell& vals) : map (), key_list (), dimensions (vals.dims ()) { map[k] = vals; key_list.push_back (k); } Octave_map (const std::string& k, const octave_value_list& val_list) : map (), key_list (), dimensions (1, val_list.length ()) { map[k] = val_list; key_list.push_back (k); } Octave_map (const Octave_map& m) : map (m.map), key_list (m.key_list), dimensions (m.dimensions) { } Octave_map (const octave_map& m); Octave_map& operator = (const Octave_map& m) { if (this != &m) { map = m.map; key_list = m.key_list; dimensions = m.dimensions; } return *this; } ~Octave_map (void) { } Octave_map squeeze (void) const; Octave_map permute (const Array<int>& vec, bool inv = false) const; // This is the number of keys. octave_idx_type nfields (void) const { return map.size (); } void del (const std::string& k) { iterator p = map.find (k); if (p != map.end ()) { map.erase (p); key_list_iterator q = std::find (key_list.begin (), key_list.end (), k); assert (q != key_list.end ()); key_list.erase (q); } } iterator begin (void) { return iterator (map.begin ()); } const_iterator begin (void) const { return const_iterator (map.begin ()); } iterator end (void) { return iterator (map.end ()); } const_iterator end (void) const { return const_iterator (map.end ()); } std::string key (const_iterator p) const { return p->first; } Cell& contents (const std::string& k); Cell contents (const std::string& k) const; Cell& contents (iterator p) { return p->second; } Cell contents (const_iterator p) const { return p->second; } int intfield (const std::string& k, int def_val = 0) const; std::string stringfield (const std::string& k, const std::string& def_val = std::string ()) const; iterator seek (const std::string& k) { return map.find (k); } const_iterator seek (const std::string& k) const { return map.find (k); } bool contains (const std::string& k) const { return (seek (k) != map.end ()); } void clear (void) { map.clear (); key_list.clear (); } string_vector keys (void) const; octave_idx_type rows (void) const { return dimensions(0); } octave_idx_type columns (void) const { return dimensions(1); } dim_vector dims (void) const { return dimensions; } int ndims (void) const { return dimensions.length (); } Octave_map transpose (void) const; Octave_map reshape (const dim_vector& new_dims) const; void resize (const dim_vector& dv, bool fill = false); octave_idx_type numel (void) const { return dimensions.numel (); } Octave_map concat (const Octave_map& rb, const Array<octave_idx_type>& ra_idx); Octave_map& maybe_delete_elements (const octave_value_list& idx); Octave_map& assign (const octave_value_list& idx, const Octave_map& rhs); Octave_map& assign (const octave_value_list& idx, const std::string& k, const Cell& rhs); Octave_map& assign (const std::string& k, const octave_value& rhs); Octave_map& assign (const std::string& k, const Cell& rhs); Octave_map index (const octave_value_list& idx, bool resize_ok = false) const; private: // The map of names to values. std::map<std::string, Cell> map; // An extra list of keys, so we can keep track of the order the keys // are added for compatibility with you know what. std::list<std::string> key_list; // The current size. mutable dim_vector dimensions; void maybe_add_to_key_list (const std::string& k) { if (! contains (k)) key_list.push_back (k); } } GCC_ATTR_DEPRECATED; #endif