Mercurial > octave
view libinterp/corefcn/oct-map.h @ 21244:1473547f50f5
include octave-config.h in public header files
* mk-opts.pl, mkbuiltins, mk-ops.awk, sparse-mk-ops.awk:
Emit "#include octave-config.h" statement for generated header files.
* build-env.h, builtins.h, Cell.h, base-text-renderer.h,
c-file-ptr-stream.h, cdisplay.h, comment-list.h, data.h, debug.h,
defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h,
dynamic-ld.h, error.h, errwarn.h, event-queue.h, file-io.h,
ft-text-renderer.h, gl-render.h, gl2ps-print.h, graphics.in.h,
gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h,
jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h,
ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h,
ls-utils.h, mex.h, mexproto.h, mxarray.in.h, oct-errno.h, oct-fstrm.h,
oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h,
oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.h,
oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h,
octave-default-image.h, octave-link.h, octave-preserve-stream-state.h,
pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h,
sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h,
sysdep.h, text-renderer.h, toplev.h, txt-eng.h, utils.h, variables.h,
workspace-element.h, xdiv.h, xnorm.h, xpow.h, zfstream.h, oct-qhull.h,
ov-base-diag.h, ov-base-int.h, ov-base-mat.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.h, ov-cs-list.h, ov-cx-diag.h,
ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.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-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h,
ov-intx.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.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-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h,
ov-uint8.h, ov-usr-fcn.h, ov.h, ovl.h, octave.h, op-int.h, ops.h,
options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h,
pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h,
pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h,
pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h,
pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h,
pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h,
pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h,
Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
CRowVector.h, CSparse.h, DiagArray2.h, MArray.h, MDiagArray2.h,
MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h,
boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h,
dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h,
dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h,
fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h,
fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h,
int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h,
uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h,
f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h,
CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h,
CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h,
DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h,
ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, base-aepbal.h, base-dae.h,
base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun.h,
dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h,
dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.h,
fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h,
fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h,
fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h,
floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h,
lo-mappers.h, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h,
oct-rand.h, oct-spparms.h, randgamma.h, randmtzig.h, randpoisson.h,
sparse-chol.h, sparse-dmsolve.h, sparse-lu.h, sparse-qr.h,
Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h,
Sparse-perm-op-defs.h, mx-base.h, mx-defs.h, mx-ext.h, mx-op-decl.h,
mx-op-defs.h, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h,
mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h,
oct-syscalls.h, oct-time.h, oct-uname.h, pathlen.h, sysdir.h,
syswait.h, action-container.h, base-list.h, byte-swap.h,
caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h,
glob-match.h, lo-array-errwarn.h, lo-array-gripes.h, lo-cutils.h,
lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h,
lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h,
oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h,
oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h,
pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h,
statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h:
Include octave-config.h.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2016 14:25:53 -0500 |
parents | 538b57866b90 |
children | ae4d7dfea337 |
line wrap: on
line source
/* Copyright (C) 1994-2015 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 "octave-config.h" #include <algorithm> #include <map> #include "Cell.h" #include "ovl.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.numel ()) { } 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.numel (), Cell (1, 1)), dimensions (1, 1) { } octave_map (const dim_vector& dv, const string_vector& k) : xkeys (k), xvals (k.numel (), 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& 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 (); } #endif