Mercurial > hg > octave-nkf
annotate doc/liboctave/array.texi @ 19790:446c46af4b42 stable
strip trailing whitespace from most source files
* Makefile.am, NEWS, build-aux/common.mk, configure.ac,
doc/Makefile.am, doc/doxyhtml/Makefile.am,
doc/interpreter/Makefile.am, doc/interpreter/arith.txi,
doc/interpreter/audio.txi, doc/interpreter/basics.txi,
doc/interpreter/bugs.txi, doc/interpreter/container.txi,
doc/interpreter/cp-idx.txi, doc/interpreter/data.txi,
doc/interpreter/debug.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README,
doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi,
doc/interpreter/errors.txi, doc/interpreter/eval.txi,
doc/interpreter/expr.txi, doc/interpreter/external.txi,
doc/interpreter/fn-idx.txi, doc/interpreter/func.txi,
doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m,
doc/interpreter/gpl.txi, doc/interpreter/grammar.txi,
doc/interpreter/gui.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/interpimages.m, doc/interpreter/intro.txi,
doc/interpreter/io.txi, doc/interpreter/java.txi,
doc/interpreter/linalg.txi, doc/interpreter/macros.texi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi,
doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1,
doc/interpreter/octave.texi, doc/interpreter/oop.txi,
doc/interpreter/op-idx.txi, doc/interpreter/optim.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/poly.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/set.txi,
doc/interpreter/signal.txi, doc/interpreter/sparse.txi,
doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m,
doc/interpreter/stats.txi, doc/interpreter/stmt.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/testfun.txi, doc/interpreter/tips.txi,
doc/interpreter/var.txi, doc/interpreter/vectorize.txi,
doc/liboctave/Makefile.am, doc/liboctave/array.texi,
doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi,
doc/liboctave/dae.texi, doc/liboctave/diffeq.texi,
doc/liboctave/error.texi, doc/liboctave/factor.texi,
doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi,
doc/liboctave/install.texi, doc/liboctave/intro.texi,
doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi,
doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi,
doc/liboctave/ode.texi, doc/liboctave/optim.texi,
doc/liboctave/preface.texi, doc/liboctave/quad.texi,
doc/liboctave/range.texi, doc/refcard/Makefile.am,
doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2,
etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog,
etc/OLD-ChangeLogs/doc-ChangeLog,
etc/OLD-ChangeLogs/scripts-ChangeLog,
etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog,
etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW,
etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am,
examples/@polynomial/end.m, examples/@polynomial/subsasgn.m,
examples/Makefile.am, examples/standalonebuiltin.cc,
libgui/Makefile.am, libgui/qterminal/libqterminal/README,
libgui/qterminal/libqterminal/unix/BlockArray.cpp,
libgui/qterminal/libqterminal/unix/BlockArray.h,
libgui/qterminal/libqterminal/unix/Character.h,
libgui/qterminal/libqterminal/unix/CharacterColor.h,
libgui/qterminal/libqterminal/unix/Emulation.cpp,
libgui/qterminal/libqterminal/unix/Emulation.h,
libgui/qterminal/libqterminal/unix/Filter.cpp,
libgui/qterminal/libqterminal/unix/Filter.h,
libgui/qterminal/libqterminal/unix/History.cpp,
libgui/qterminal/libqterminal/unix/History.h,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.h,
libgui/qterminal/libqterminal/unix/LineFont.h,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h,
libgui/qterminal/libqterminal/unix/Screen.cpp,
libgui/qterminal/libqterminal/unix/Screen.h,
libgui/qterminal/libqterminal/unix/ScreenWindow.cpp,
libgui/qterminal/libqterminal/unix/ScreenWindow.h,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h,
libgui/qterminal/libqterminal/unix/Vt102Emulation.h,
libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp,
libgui/qterminal/qterminal/main.cpp,
libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc,
libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc,
libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc,
libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy,
libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc,
libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc,
libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl,
libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add,
libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs,
libinterp/mkops, libinterp/octave-value/ov-java.cc,
libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/octave.gperf, liboctave/Makefile.am,
liboctave/array/Array.cc, liboctave/array/module.mk,
liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f,
liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f,
liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f,
liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f,
liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f,
liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f,
liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f,
liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f,
liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f,
liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f,
liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f,
liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f,
liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f,
liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f,
liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f,
liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f,
liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk,
liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f,
liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f,
liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f,
liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f,
liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f,
liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc,
liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f,
liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f,
liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f,
liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f,
liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc,
liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for,
liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f,
liboctave/cruft/slatec-fn/datanh.f,
liboctave/cruft/slatec-fn/xgmainc.f,
liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk,
liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops,
liboctave/operators/sparse-mk-ops.awk,
liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops,
liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m,
scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m,
scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m,
scripts/deprecated/java_new.m,
scripts/deprecated/java_unsigned_conversion.m,
scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m,
scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m,
scripts/general/display.m, scripts/general/fieldnames.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/isa.m,
scripts/general/methods.m, scripts/general/sortrows.m,
scripts/geometry/convhull.m, scripts/geometry/delaunay.m,
scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m,
scripts/geometry/griddata.m, scripts/geometry/griddatan.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/gui/guihandles.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m,
scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m,
scripts/image/bone.m, scripts/image/cmpermute.m,
scripts/image/cmunique.m, scripts/image/colorcube.m,
scripts/image/colormap.m, scripts/image/contrast.m,
scripts/image/gray2ind.m, scripts/image/image.m,
scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m,
scripts/image/rgb2ntsc.m, scripts/image/spinmap.m,
scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m,
scripts/io/textscan.m, scripts/java/java_get.m,
scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m,
scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m,
scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m,
scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m,
scripts/mk-pkg-add, scripts/mkdoc.pl,
scripts/optimization/fminsearch.m, scripts/optimization/optimset.m,
scripts/optimization/sqp.m, scripts/pkg/pkg.m,
scripts/pkg/private/create_pkgadddel.m,
scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m,
scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m,
scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m,
scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m,
scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m,
scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m,
scripts/plot/draw/area.m, scripts/plot/draw/bar.m,
scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m,
scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m,
scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m,
scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m,
scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m,
scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m,
scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m,
scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m,
scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m,
scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m,
scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m,
scripts/plot/draw/private/__contour__.m,
scripts/plot/draw/private/__errplot__.m,
scripts/plot/draw/private/__ezplot__.m,
scripts/plot/draw/private/__patch__.m,
scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m,
scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m,
scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m,
scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m,
scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m,
scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m,
scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m,
scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m,
scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m,
scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m,
scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m,
scripts/plot/util/__gnuplot_drawnow__.m,
scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m,
scripts/plot/util/clf.m, scripts/plot/util/copyobj.m,
scripts/plot/util/figure.m, scripts/plot/util/gcbo.m,
scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m,
scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m,
scripts/plot/util/print.m,
scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/private/__fltk_print__.m,
scripts/plot/util/private/__gnuplot_print__.m,
scripts/plot/util/private/__print_parse_opts__.m,
scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m,
scripts/polynomial/conv.m, scripts/polynomial/poly.m,
scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m,
scripts/polynomial/polyval.m,
scripts/polynomial/private/__splinefit__.m,
scripts/polynomial/spline.m, scripts/prefs/prefdir.m,
scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m,
scripts/prefs/rmpref.m, scripts/signal/freqz.m,
scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m,
scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m,
scripts/specfun/expint.m, scripts/specfun/factor.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m,
scripts/special-matrix/toeplitz.m, scripts/startup/inputrc,
scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m,
scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m,
scripts/statistics/distributions/betarnd.m,
scripts/statistics/distributions/binoinv.m,
scripts/statistics/distributions/binopdf.m,
scripts/statistics/distributions/binornd.m,
scripts/statistics/distributions/cauchy_rnd.m,
scripts/statistics/distributions/chi2rnd.m,
scripts/statistics/distributions/discrete_pdf.m,
scripts/statistics/distributions/discrete_rnd.m,
scripts/statistics/distributions/empirical_rnd.m,
scripts/statistics/distributions/exprnd.m,
scripts/statistics/distributions/frnd.m,
scripts/statistics/distributions/gamrnd.m,
scripts/statistics/distributions/geornd.m,
scripts/statistics/distributions/hygernd.m,
scripts/statistics/distributions/kolmogorov_smirnov_cdf.m,
scripts/statistics/distributions/laplace_cdf.m,
scripts/statistics/distributions/laplace_pdf.m,
scripts/statistics/distributions/logistic_cdf.m,
scripts/statistics/distributions/logistic_pdf.m,
scripts/statistics/distributions/lognrnd.m,
scripts/statistics/distributions/nbincdf.m,
scripts/statistics/distributions/nbininv.m,
scripts/statistics/distributions/nbinpdf.m,
scripts/statistics/distributions/nbinrnd.m,
scripts/statistics/distributions/normrnd.m,
scripts/statistics/distributions/poissinv.m,
scripts/statistics/distributions/poissrnd.m,
scripts/statistics/distributions/tinv.m,
scripts/statistics/distributions/trnd.m,
scripts/statistics/distributions/unidcdf.m,
scripts/statistics/distributions/unidpdf.m,
scripts/statistics/distributions/unidrnd.m,
scripts/statistics/distributions/unifrnd.m,
scripts/statistics/distributions/wblrnd.m,
scripts/statistics/models/module.mk,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/strings/base2dec.m, scripts/strings/deblank.m,
scripts/strings/dec2base.m, scripts/strings/dec2bin.m,
scripts/strings/dec2hex.m, scripts/strings/mat2str.m,
scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m,
scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjoin.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m,
scripts/testfun/test.m, scripts/time/asctime.m,
scripts/time/datenum.m, scripts/time/datevec.m,
scripts/time/weekday.m, src/Makefile.am, test/Makefile.am,
test/build-bc-overload-tests.sh, test/build-sparse-tests.sh,
test/jit.tst, test/line-continue.tst: Strip trailing whitespace.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 20 Jan 2015 08:26:57 -0500 |
| parents | d63878346099 |
| children | 4197fc428c7d |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
1 @c Copyright (C) 1996-2013 John W. Eaton |
| 7018 | 2 @c |
| 3 @c This file is part of Octave. | |
| 4 @c | |
| 5 @c Octave is free software; you can redistribute it and/or modify it | |
| 6 @c under the terms of the GNU General Public License as published by the | |
| 7 @c Free Software Foundation; either version 3 of the License, or (at | |
| 8 @c your option) any later version. | |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
9 @c |
| 7018 | 10 @c Octave is distributed in the hope that it will be useful, but WITHOUT |
| 11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 @c for more details. | |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
14 @c |
| 7018 | 15 @c You should have received a copy of the GNU General Public License |
| 16 @c along with Octave; see the file COPYING. If not, see | |
| 17 @c <http://www.gnu.org/licenses/>. | |
| 18 | |
| 3178 | 19 @node Arrays, Matrix and Vector Operations, Introduction, Top |
| 2333 | 20 @chapter Arrays |
| 21 @cindex arrays | |
| 22 | |
| 23 @menu | |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
24 * Constructors and Assignment:: |
| 2333 | 25 @end menu |
| 26 | |
| 27 @node Constructors and Assignment, , Arrays, Arrays | |
| 28 @section Constructors and Assignment | |
| 29 | |
| 3920 | 30 @deftypefn Constructor {} Array<T> (void) |
| 2333 | 31 Create an array with no elements. |
| 32 @end deftypefn | |
| 33 | |
| 3920 | 34 @deftypefn Constructor {} Array<T> (int @var{n} [, const T &@var{val}]) |
| 2333 | 35 Create an array with @var{n} elements. If the optional argument |
| 36 @var{val} is supplied, the elements are initialized to @var{val}; | |
| 37 otherwise, they are left uninitialized. If @var{n} is less than zero, | |
| 38 the current error handler is invoked (@pxref{Error Handling}). | |
| 39 @end deftypefn | |
| 40 | |
| 3920 | 41 @deftypefn Constructor {} Array<T> (const Array<T> &@var{a}) |
| 2333 | 42 Create a copy of the @var{Array<T>} object @var{a}. Memory for the |
| 43 @var{Array<T>} class is managed using a reference counting scheme, so | |
| 44 the cost of this operation is independent of the size of the array. | |
| 45 @end deftypefn | |
| 46 | |
| 3920 | 47 @deftypeop Assignment Array<T> Array<T>& {operator =} (const Array<T> &@var{a}) |
| 2333 | 48 Assignment operator. Memory for the @var{Array<T>} class is managed |
| 49 using a reference counting scheme, so the cost of this operation is | |
| 50 independent of the size of the array. | |
| 3920 | 51 @end deftypeop |
| 2333 | 52 |
| 3920 | 53 @deftypemethod Array<T> int capacity (void) const |
| 54 @deftypemethodx Array<T> int length (void) const | |
| 2333 | 55 Return the length of the array. |
| 3920 | 56 @end deftypemethod |
| 2333 | 57 |
| 3920 | 58 @deftypemethod Array<T> T& elem (int @var{n}) |
| 59 @deftypemethodx Array<T> T& checkelem (int @var{n}) | |
| 2333 | 60 If @var{n} is within the bounds of the array, return a reference to the |
| 61 element indexed by @var{n}; otherwise, the current error handler is | |
| 62 invoked (@pxref{Error Handling}). | |
| 3920 | 63 @end deftypemethod |
| 2333 | 64 |
| 3920 | 65 @deftypeop Indexing Array<T> T& {operator ()} (int @var{n}) |
| 66 @end deftypeop | |
| 67 | |
| 68 @deftypemethod Array<T> T elem (int @var{n}) const | |
| 69 @deftypemethodx Array<T> T checkelem (int @var{n}) const | |
| 2333 | 70 If @var{n} is within the bounds of the array, return the value indexed |
| 71 by @var{n}; otherwise, call the current error handler. | |
| 72 @xref{Error Handling}. | |
| 3920 | 73 @end deftypemethod |
| 2333 | 74 |
| 3920 | 75 @deftypeop Indexing Array<T> T {operator ()} (int @var{n}) const |
| 76 @end deftypeop | |
| 77 | |
| 78 @deftypemethod Array<T> T& xelem (int @var{n}) | |
| 79 @deftypemethodx Array<T> T xelem (int @var{n}) const | |
| 2333 | 80 Return a reference to, or the value of, the element indexed by @var{n}. |
| 81 These methods never perform bounds checking. | |
| 3920 | 82 @end deftypemethod |
| 2333 | 83 |
| 3920 | 84 @deftypemethod Array<T> void resize {(int @var{n} [, const T &@var{val}])} |
| 2333 | 85 Change the size of the array to be @var{n} elements. All elements are |
| 86 unchanged, except that if @var{n} is greater than the current size and | |
| 87 the optional argument @var{val} is provided, the additional elements are | |
| 88 initialized to @var{val}; otherwise, any additional elements are left | |
| 89 uninitialized. In the current implementation, if @var{n} is less than | |
| 90 the current size, the length is updated but no memory is released. | |
| 3920 | 91 @end deftypemethod |
| 2333 | 92 |
| 3920 | 93 @deftypemethod Array<T> {const T*} data (void) const |
| 94 @end deftypemethod | |
| 2333 | 95 |
| 96 @c Should this be public? | |
| 97 @c | |
| 98 @c T *fortran_vec (void) | |
| 99 | |
| 3920 | 100 @deftypefn Constructor {} Array2<T> Array2<T> Array2 (void) |
| 101 @deftypefnx Constructor {} Array2<T> (int @var{n}, int @var{m}) | |
| 102 @deftypefnx Constructor {} Array2<T> (int @var{n}, int @var{m}, const T &@var{val}) | |
| 103 @deftypefnx Constructor {} Array2<T> (const Array2<T> &@var{a}) | |
| 104 @deftypefnx Constructor {} Array2<T> (const DiagArray<T> &@var{a}) | |
| 2333 | 105 @end deftypefn |
| 106 | |
| 3920 | 107 @deftypeop Assignment Array2<T> Array2<T>& {operator =} (const Array2<T> &@var{a}) |
| 108 @end deftypeop | |
| 109 | |
| 110 @deftypemethod Array2<T> int dim1 (void) const | |
| 111 @deftypemethodx Array2<T> int rows (void) const | |
| 112 @end deftypemethod | |
| 2333 | 113 |
| 3920 | 114 @deftypemethod Array2<T> int dim2 (void) const |
| 115 @deftypemethodx Array2<T> int cols (void) const | |
| 116 @deftypemethodx Array2<T> int columns (void) const | |
| 117 @end deftypemethod | |
| 2333 | 118 |
| 3920 | 119 @deftypemethod Array2<T> T& elem (int @var{i}, int @var{j}) |
| 120 @deftypemethodx Array2<T> T& checkelem (int @var{i}, int @var{j}) | |
| 121 @end deftypemethod | |
| 122 | |
| 123 @deftypeop Indexing Array2<T> T& {operator ()} (int @var{i}, int @var{j}) | |
| 124 @end deftypeop | |
| 2333 | 125 |
| 126 @c This needs to be fixed. | |
| 127 @c | |
| 128 @c T& xelem (int i, int j) | |
| 129 @c | |
| 130 @c T elem (int i, int j) const | |
| 131 @c T checkelem (int i, int j) const | |
| 132 @c T operator () (int i, int j) const | |
| 133 | |
| 3920 | 134 @deftypemethod Array2<T> void resize (int @var{n}, int @var{m}) |
| 135 @deftypemethodx Array2<T> void resize (int @var{n}, int @var{m}, const T &@var{val}) | |
| 136 @end deftypemethod | |
| 2333 | 137 |
| 3920 | 138 @deftypefn Constructor {} Array3<T> (void) |
| 139 @deftypefnx Constructor {} Array3<T> (int @var{n}, int @var{m}, int @var{k}) | |
| 140 @deftypefnx Constructor {} Array3<T> (int @var{n}, int @var{m}, int @var{k}, const T &@var{val}) | |
| 141 @deftypefnx Constructor {} Array3<T> (const Array3<T> &@var{a}) | |
| 2333 | 142 @end deftypefn |
| 143 | |
| 3920 | 144 @deftypeop Assignment Array3<T> Array3<T>& {operator =} (const Array3<T> &@var{a}) |
| 145 @end deftypeop | |
| 2333 | 146 |
| 3920 | 147 @deftypemethod Array3<T> int dim1 (void) const |
| 148 @deftypemethodx Array3<T> int dim2 (void) const | |
| 149 @deftypemethodx Array3<T> int dim3 (void) const | |
| 150 @end deftypemethod | |
| 2333 | 151 |
| 3920 | 152 @deftypemethod Array3<T> T& elem (int @var{i}, int @var{j}, int @var{k}) |
| 153 @deftypemethodx Array3<T> T& checkelem (int @var{i}, int @var{j}, int @var{k}) | |
| 154 @end deftypemethod | |
| 155 | |
| 156 @deftypeop Indexing Array3<T> T& {operator ()} (int @var{i}, int @var{j}, int @var{k}) | |
| 157 @end deftypeop | |
| 2333 | 158 |
| 159 @c This needs to be fixed. | |
| 160 @c | |
| 161 @c T& xelem (int i, int j, int k) | |
| 162 @c | |
| 163 @c T elem (int i, int j, int k) const | |
| 164 @c T checkelem (int i, int j, int k) const | |
| 165 @c T operator () (int i, int j, int k) const | |
| 166 | |
| 3920 | 167 @deftypemethod Array3<T> void resize (int @var{n}, int @var{m}, int @var{k}) |
| 168 @deftypemethodx Array3<T> void resize (int @var{n}, int @var{m}, int @var{k}, const T &@var{val}) | |
| 169 @end deftypemethod | |
| 2333 | 170 |
| 3920 | 171 @deftypefn Constructor {} DiagArray<T> (void) |
| 172 @deftypefnx Constructor {} DiagArray<T> (int @var{n}) | |
| 173 @deftypefnx Constructor {} DiagArray<T> (int @var{n}, const T &@var{val}) | |
| 174 @deftypefnx Constructor {} DiagArray<T> (int @var{r}, int @var{c}) | |
| 175 @deftypefnx Constructor {} DiagArray<T> (int @var{r}, int @var{c}, const T &@var{val}) | |
| 176 @deftypefnx Constructor {} DiagArray<T> (const Array<T> &@var{a}) | |
| 177 @deftypefnx Constructor {} DiagArray<T> (const DiagArray<T> &@var{a}) | |
| 2333 | 178 @end deftypefn |
| 179 | |
|
12702
013cd94d8d7f
doc: Spelling fixes for various documentation files
John Bradshaw <john@johnbradshaw.org>
parents:
11523
diff
changeset
|
180 @deftypeop Assignment DiagArray<T>& {} {operator =} (const DiagArray<T> &@var{a}) |
| 3920 | 181 @end deftypeop |
| 2333 | 182 |
| 3920 | 183 @deftypemethod DiagArray<T> int dim1 (void) const |
| 184 @deftypemethodx DiagArray<T> int rows (void) const | |
| 185 @end deftypemethod | |
| 2333 | 186 |
| 3920 | 187 @deftypemethod DiagArray<T> int dim2 (void) const |
| 188 @deftypemethodx DiagArray<T> int cols (void) const | |
| 189 @deftypemethodx DiagArray<T> int columns (void) const | |
| 190 @end deftypemethod | |
| 2333 | 191 |
| 3920 | 192 @deftypemethod DiagArray<T> T& elem (int @var{r}, int @var{c}) |
| 193 @deftypemethodx DiagArray<T> T& checkelem (int @var{r}, int @var{c}) | |
| 194 @end deftypemethod | |
| 195 | |
| 196 @deftypeop Indexing DiagArray<T> T& {operator ()} (int @var{r}, int @var{c}) | |
| 197 @end deftypeop | |
| 2333 | 198 |
| 199 @c This needs to be fixed. | |
| 200 @c | |
| 201 @c T& xelem (int r, int c) | |
| 202 @c | |
| 203 @c T elem (int r, int c) const | |
| 204 @c T checkelem (int r, int c) const | |
| 205 @c T operator () (int r, int c) const | |
| 206 | |
| 3920 | 207 @deftypemethod DiagArray<T> void resize (int @var{n}, int @var{m}) |
| 208 @deftypemethodx DiagArray<T> void resize (int @var{n}, int @var{m}, const T &@var{val}) | |
| 209 @end deftypemethod |