Mercurial > octave-dspies

view doc/interpreter/octave.1 @ 19010:3fb030666878 draft default tip dspies

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added special-case logical-indexing function * logical-index.h (New file) : Logical-indexing function. May be called on octave_value types via call_bool_index * nz-iterators.h : Add base-class nz_iterator for iterator types. Array has template bool for whether to internally store row-col or compute on the fly Add skip_ahead method which skips forward to the next nonzero after its argument Add flat_index for computing octave_idx_type index of current position (with assertion failure in the case of overflow) Move is_zero to separate file * ov-base-diag.cc, ov-base-mat.cc, ov-base-sparse.cc, ov-perm.cc (do_index_op): Add call to call_bool_index in logical-index.h * Array.h : Move forward-declaration for array_iterator to separate header file * dim-vector.cc (dim_max): Refers to idx-bounds.h (max_idx) * array-iter-decl.h (New file): Header file for forward declaration of array-iterator * direction.h : Add constants fdirc and bdirc to avoid having to reconstruct them * dv-utils.h, dv-utils.cc (New files) : Utility functions for querying and constructing dim-vectors * idx-bounds.h (New file) : Utility constants and functions for determining whether things will overflow the maximum allowed bounds * interp-idx.h (New function : to_flat_idx) : Converts row-col pair to linear index of octave_idx_type * is-zero.h (New file) : Function for determining whether an element is zero * logical-index.tst : Add tests for correct return-value dimensions and large sparse matrix behavior
author David Spies <dnspies@gmail.com>
date Fri, 25 Jul 2014 13:39:31 -0600
parents d63878346099
children
line wrap: on
line source

.\" Copyright (C) 1996-2013 John W. Eaton
.\"
.\" 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/>.
.\" --------------------------------------------------------------------
.de Vb \" (V)erbatim (b)egin.  Use fixed width font and no justification
.ft CW
.nf
..
.de Ve \" (V)erbatim (e)nd.  Return to regular font and justification
.ft R
.fi
..
.\" --------------------------------------------------------------------
.TH OCTAVE 1 "19 October 2012" "GNU Octave"
.SH NAME
octave \- A high-level interactive language for numerical computations.
.SH SYNOPSIS
\fBoctave\fP [\fIoptions\fP]... [\fIfile\fP]
.SH DESCRIPTION
Octave is a high-level language, primarily intended for numerical
computations.  It provides a convenient command line interface for
solving linear and nonlinear problems numerically.
.SH OPTIONS
The complete set of command-line options for \fBoctave\fP is available by
running the following command from the shell.
.Vb

    octave \-\-help
.Ve
.SH DOCUMENTATION
The primary documentation for Octave is written using Texinfo, the GNU
documentation system, which allows the same source files to be used to
produce online and printed versions of the manual.
.PP
You can read the online copy of the Octave documentation by issuing
the following command from within \fBoctave\fP.
.Vb

    octave:1> doc

.Ve
The Info files may also be read with a stand-alone program such as
\fBinfo\fP or \fBxinfo\fP.  HTML, Postscript, or PDF versions of the
documentation are installed on many systems as well.
.SH BUGS
The Octave project maintains a bug tracker at http://bugs.octave.org.
Before submitting a new item please read the instructions at
http://www.octave.org/bugs.html on how to submit a useful report.
.SH FILES
Upon startup Octave looks for four initialization files.  Each file
may contain any number of valid Octave commands.
.TP
\fIoctave-home\fP/share/octave/site/m/startup/octaverc
Site-wide initialization file which changes options for all users.
\fIoctave-home\fP is the directory where Octave was installed such as
\fB/usr/local\fP.
.TP
\fIoctave-home\fP/share/octave/\fIversion\fP/m/startup/octaverc
Site-wide initialization file for Octave version \fIversion\fP.
.TP
~/.octaverc
User's personal initialization file.
.TP
\&\.octaverc
Project-specific initialization file located in the current directory.
.SH AUTHOR
John W. Eaton <jwe@octave.org>