Mercurial > hg > octave-lojdl
changeset 17158:f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Remove excess spaces from ends of @menu definitions.
* doc/interpreter/arith.txi, doc/interpreter/basics.txi,
doc/interpreter/bugs.txi, doc/interpreter/container.txi,
doc/interpreter/data.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/emacs.txi,
doc/interpreter/expr.txi, doc/interpreter/external.txi,
doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/gui.txi,
doc/interpreter/install.txi, doc/interpreter/intro.txi, doc/interpreter/io.txi,
doc/interpreter/java.txi, doc/interpreter/linalg.txi,
doc/interpreter/matrix.txi, doc/interpreter/nonlin.txi,
doc/interpreter/numbers.txi, doc/interpreter/octave.texi,
doc/interpreter/optim.txi, doc/interpreter/plot.txi,
doc/interpreter/preface.txi, doc/interpreter/quad.txi,
doc/interpreter/sparse.txi, doc/interpreter/stats.txi,
doc/interpreter/stmt.txi, doc/interpreter/strings.txi,
doc/interpreter/system.txi, doc/interpreter/var.txi:
Shorten some long subsection names in Manual.
Remove excess spaces from ends of @menu definitions.
line wrap: on
line diff
--- a/doc/interpreter/arith.txi +++ b/doc/interpreter/arith.txi @@ -34,14 +34,14 @@ @menu * Exponents and Logarithms:: -* Complex Arithmetic:: -* Trigonometry:: -* Sums and Products:: -* Utility Functions:: -* Special Functions:: +* Complex Arithmetic:: +* Trigonometry:: +* Sums and Products:: +* Utility Functions:: +* Special Functions:: * Rational Approximations:: * Coordinate Transformations:: -* Mathematical Constants:: +* Mathematical Constants:: @end menu @node Exponents and Logarithms
--- a/doc/interpreter/basics.txi +++ b/doc/interpreter/basics.txi @@ -25,13 +25,13 @@ from your shell. @menu -* Invoking Octave from the Command Line:: -* Quitting Octave:: -* Getting Help:: -* Command Line Editing:: -* Errors:: -* Executable Octave Programs:: -* Comments:: +* Invoking Octave from the Command Line:: +* Quitting Octave:: +* Getting Help:: +* Command Line Editing:: +* Errors:: +* Executable Octave Programs:: +* Comments:: @end menu @node Invoking Octave from the Command Line @@ -52,8 +52,8 @@ shorter equivalent). @menu -* Command Line Options:: -* Startup Files:: +* Command Line Options:: +* Startup Files:: @end menu @node Command Line Options @@ -484,14 +484,14 @@ @menu -* Cursor Motion:: -* Killing and Yanking:: -* Commands For Text:: -* Commands For Completion:: -* Commands For History:: -* Customizing readline:: -* Customizing the Prompt:: -* Diary and Echo Commands:: +* Cursor Motion:: +* Killing and Yanking:: +* Commands For Text:: +* Commands For Completion:: +* Commands For History:: +* Customizing readline:: +* Customizing the Prompt:: +* Diary and Echo Commands:: @end menu @node Cursor Motion @@ -1047,7 +1047,7 @@ @menu * Single Line Comments:: * Block Comments:: -* Comments and the Help System:: +* Comments and the Help System:: @end menu @node Single Line Comments
--- a/doc/interpreter/bugs.txi +++ b/doc/interpreter/bugs.txi @@ -52,8 +52,8 @@ @menu * Actual Bugs:: Bugs we will fix later. -* Reporting Bugs:: -* Service:: +* Reporting Bugs:: +* Service:: @end menu @node Actual Bugs @@ -105,7 +105,7 @@ information that makes it possible to fix the bug. @menu -* Bug Criteria:: +* Bug Criteria:: * Bug Tracker:: Where to submit your bug report. * Bug Reporting:: How to report a bug effectively. * Sending Patches:: How to send a patch for Octave.
--- a/doc/interpreter/container.txi +++ b/doc/interpreter/container.txi @@ -640,7 +640,7 @@ @DOCSTRING(iscell) @node Creating Cell Arrays -@subsection Creating Cell Array +@subsection Creating Cell Arrays The introductory example (@pxref{Basic Usage of Cell Arrays}) showed how to create a cell array containing currently available variables.
--- a/doc/interpreter/data.txi +++ b/doc/interpreter/data.txi @@ -35,9 +35,9 @@ @DOCSTRING(typeinfo) @menu -* Built-in Data Types:: -* User-defined Data Types:: -* Object Sizes:: +* Built-in Data Types:: +* User-defined Data Types:: +* Object Sizes:: @end menu @node Built-in Data Types @@ -70,11 +70,11 @@ @DOCSTRING(bitunpack) @menu -* Numeric Objects:: -* Missing Data:: -* String Objects:: -* Data Structure Objects:: -* Cell Array Objects:: +* Numeric Objects:: +* Missing Data:: +* String Objects:: +* Data Structure Objects:: +* Cell Array Objects:: @end menu @node Numeric Objects
--- a/doc/interpreter/diagperm.txi +++ b/doc/interpreter/diagperm.txi @@ -16,19 +16,19 @@ @c along with Octave; see the file COPYING. If not, see @c <http://www.gnu.org/licenses/>. -@node Diagonal and Permutation Matrices +@node Diagonal and Permutation Matrices @chapter Diagonal and Permutation Matrices @menu -* Basic Usage:: Creation and Manipulation of Diagonal and Permutation Matrices -* Matrix Algebra:: Linear Algebra with Diagonal and Permutation Matrices +* Basic Usage:: Creation and Manipulation of Diagonal/Permutation Matrices +* Matrix Algebra:: Linear Algebra with Diagonal/Permutation Matrices * Function Support:: Functions That Are Aware of These Matrices -* Example Code:: Some Examples of Usage -* Zeros Treatment:: The Differences in Treatment of Zero Elements +* Example Code:: Examples of Usage +* Zeros Treatment:: Differences in Treatment of Zero Elements @end menu @node Basic Usage -@section Creating and Manipulating Diagonal and Permutation Matrices +@section Creating and Manipulating Diagonal/Permutation Matrices A diagonal matrix is defined as a matrix that has zero entries outside the main diagonal; that is, @@ -210,7 +210,7 @@ be very cheap. @node Matrix Algebra -@section Linear Algebra with Diagonal and Permutation Matrices +@section Linear Algebra with Diagonal/Permutation Matrices As has been already said, diagonal and permutation matrices make it possible to use efficient algorithms while preserving natural linear @@ -413,7 +413,7 @@ making it possible to conveniently obtain the permutation indices. @node Example Code -@section Some Examples of Usage +@section Examples of Usage The following can be used to solve a linear system @code{A*x = b} using the pivoted LU@tie{}factorization: @@ -476,7 +476,7 @@ @node Zeros Treatment -@section The Differences in Treatment of Zero Elements +@section Differences in Treatment of Zero Elements Making diagonal and permutation matrices special matrix objects in their own right and the consequent usage of smarter algorithms for certain operations
--- a/doc/interpreter/diffeq.txi +++ b/doc/interpreter/diffeq.txi @@ -24,8 +24,8 @@ All solvers are based on reliable ODE routines written in Fortran. @menu -* Ordinary Differential Equations:: -* Differential-Algebraic Equations:: +* Ordinary Differential Equations:: +* Differential-Algebraic Equations:: @end menu @cindex differential equations
--- a/doc/interpreter/emacs.txi +++ b/doc/interpreter/emacs.txi @@ -44,10 +44,10 @@ or suggestions on using EOS. @menu -* Installing EOS:: -* Using Octave Mode:: -* Running Octave from Within Emacs:: -* Using the Emacs Info Reader for Octave:: +* Installing EOS:: +* Using Octave Mode:: +* Running Octave from Within Emacs:: +* Using the Emacs Info Reader for Octave:: @end menu @node Installing EOS
--- a/doc/interpreter/expr.txi +++ b/doc/interpreter/expr.txi @@ -32,14 +32,14 @@ combinations of these with various operators. @menu -* Index Expressions:: -* Calling Functions:: -* Arithmetic Ops:: -* Comparison Ops:: -* Boolean Expressions:: -* Assignment Ops:: -* Increment Ops:: -* Operator Precedence:: +* Index Expressions:: +* Calling Functions:: +* Arithmetic Ops:: +* Comparison Ops:: +* Boolean Expressions:: +* Assignment Ops:: +* Increment Ops:: +* Operator Precedence:: @end menu @node Index Expressions @@ -385,8 +385,8 @@ expressions. See also @ref{Index Expressions}, and @ref{Assignment Ops}. @menu -* Call by Value:: -* Recursion:: +* Call by Value:: +* Recursion:: @end menu @node Call by Value @@ -823,8 +823,8 @@ @cindex not operator @menu -* Element-by-element Boolean Operators:: -* Short-circuit Boolean Operators:: +* Element-by-element Boolean Operators:: +* Short-circuit Boolean Operators:: @end menu @node Element-by-element Boolean Operators
--- a/doc/interpreter/external.txi +++ b/doc/interpreter/external.txi @@ -104,9 +104,9 @@ bridge to hardware resources which often have device drivers written in C. @menu -* Oct-Files:: -* Mex-Files:: -* Standalone Programs:: +* Oct-Files:: +* Mex-Files:: +* Standalone Programs:: @end menu @node Oct-Files @@ -116,19 +116,19 @@ @cindex oct @menu -* Getting Started with Oct-Files:: -* Matrices and Arrays in Oct-Files:: -* Character Strings in Oct-Files:: -* Cell Arrays in Oct-Files:: -* Structures in Oct-Files:: -* Sparse Matrices in Oct-Files:: -* Accessing Global Variables in Oct-Files:: -* Calling Octave Functions from Oct-Files:: -* Calling External Code from Oct-Files:: -* Allocating Local Memory in Oct-Files:: -* Input Parameter Checking in Oct-Files:: -* Exception and Error Handling in Oct-Files:: -* Documentation and Test of Oct-Files:: +* Getting Started with Oct-Files:: +* Matrices and Arrays in Oct-Files:: +* Character Strings in Oct-Files:: +* Cell Arrays in Oct-Files:: +* Structures in Oct-Files:: +* Sparse Matrices in Oct-Files:: +* Accessing Global Variables in Oct-Files:: +* Calling Octave Functions from Oct-Files:: +* Calling External Code from Oct-Files:: +* Allocating Local Memory in Oct-Files:: +* Input Parameter Checking in Oct-Files:: +* Exception and Error Handling in Oct-Files:: +* Documentation and Test of Oct-Files:: @c * Application Programming Interface for Oct-Files:: @end menu @@ -584,13 +584,13 @@ more similar to Octave's @code{Matrix} class than its @code{NDArray} class. @menu -* Array and Sparse Differences:: -* Creating Sparse Matrices in Oct-Files:: -* Using Sparse Matrices in Oct-Files:: +* Array and Sparse Class Differences:: +* Creating Sparse Matrices in Oct-Files:: +* Using Sparse Matrices in Oct-Files:: @end menu -@node Array and Sparse Differences -@subsubsection The Differences between the Array and Sparse Classes +@node Array and Sparse Class Differences +@subsubsection Array and Sparse Class Differences The number of elements in a sparse matrix is considered to be the number of non-zero elements rather than the product of the dimensions. Therefore @@ -1274,13 +1274,13 @@ be written with the oct-file interface previously discussed. @menu -* Getting Started with Mex-Files:: -* Working with Matrices and Arrays in Mex-Files:: -* Character Strings in Mex-Files:: -* Cell Arrays with Mex-Files:: -* Structures with Mex-Files:: -* Sparse Matrices with Mex-Files:: -* Calling Other Functions in Mex-Files:: +* Getting Started with Mex-Files:: +* Working with Matrices and Arrays in Mex-Files:: +* Character Strings in Mex-Files:: +* Cell Arrays with Mex-Files:: +* Structures with Mex-Files:: +* Sparse Matrices with Mex-Files:: +* Calling Other Functions in Mex-Files:: @c * Application Programming Interface for Mex-Files:: @end menu
--- a/doc/interpreter/func.txi +++ b/doc/interpreter/func.txi @@ -30,18 +30,18 @@ @menu * Introduction to Function and Script Files:: -* Defining Functions:: -* Multiple Return Values:: -* Variable-length Argument Lists:: -* Ignoring Arguments:: -* Variable-length Return Lists:: -* Returning from a Function:: -* Default Arguments:: -* Function Files:: -* Script Files:: -* Function Handles Inline Functions and Anonymous Functions:: +* Defining Functions:: +* Multiple Return Values:: +* Variable-length Argument Lists:: +* Ignoring Arguments:: +* Variable-length Return Lists:: +* Returning from a Function:: +* Default Arguments:: +* Function Files:: +* Script Files:: +* Function Handles Anonymous Functions Inline Functions:: * Commands:: -* Organization of Functions:: +* Organization of Functions:: @end menu @node Introduction to Function and Script Files @@ -1266,11 +1266,11 @@ @DOCSTRING(source) -@node Function Handles Inline Functions and Anonymous Functions -@section Function Handles, Inline Functions, and Anonymous Functions +@node Function Handles Anonymous Functions Inline Functions +@section Function Handles, Anonymous Functions, Inline Functions @cindex handle, function handles +@cindex anonymous functions @cindex inline, inline functions -@cindex anonymous functions It can be very convenient store a function in a variable so that it can be passed to a different function. For example, a function that
--- a/doc/interpreter/grammar.txi +++ b/doc/interpreter/grammar.txi @@ -25,8 +25,8 @@ Octave's language. @menu -* Keywords:: -* Parser:: +* Keywords:: +* Parser:: @end menu @node Keywords
--- a/doc/interpreter/gui.txi +++ b/doc/interpreter/gui.txi @@ -36,10 +36,10 @@ preferences. @menu -* I/O Dialogs:: -* Progress Bar:: -* GUI Utility Functions:: -* User-Defined Preferences:: +* I/O Dialogs:: +* Progress Bar:: +* GUI Utility Functions:: +* User-Defined Preferences:: @end menu @node I/O Dialogs
--- a/doc/interpreter/install.txi +++ b/doc/interpreter/install.txi @@ -569,7 +569,7 @@ @end table @end itemize -@node Compiling Octave with 64-bit Indexing +@node Compiling Octave with 64-bit Indexing @section Compiling Octave with 64-bit Indexing Note: the following only applies to systems that have 64-bit pointers.
--- a/doc/interpreter/intro.txi +++ b/doc/interpreter/intro.txi @@ -38,9 +38,9 @@ This document corresponds to Octave version @value{VERSION}. @menu -* Running Octave:: -* Simple Examples:: -* Conventions:: +* Running Octave:: +* Simple Examples:: +* Conventions:: @end menu @node Running Octave @@ -419,11 +419,11 @@ manual. You may want to skip this section and refer back to it later. @menu -* Fonts:: -* Evaluation Notation:: -* Printing Notation:: -* Error Messages:: -* Format of Descriptions:: +* Fonts:: +* Evaluation Notation:: +* Printing Notation:: +* Error Messages:: +* Format of Descriptions:: @end menu @node Fonts @@ -546,8 +546,8 @@ The description follows on succeeding lines, sometimes with examples. @menu -* A Sample Function Description:: -* A Sample Command Description:: +* A Sample Function Description:: +* A Sample Command Description:: @end menu @node A Sample Function Description
--- a/doc/interpreter/io.txi +++ b/doc/interpreter/io.txi @@ -26,8 +26,8 @@ after the C standard library are also provided by Octave. @menu -* Basic Input and Output:: -* C-Style I/O Functions:: +* Basic Input and Output:: +* C-Style I/O Functions:: @end menu @node Basic Input and Output @@ -36,9 +36,9 @@ @c We could use a two-line introduction here... @menu -* Terminal Output:: -* Terminal Input:: -* Simple File I/O:: +* Terminal Output:: +* Terminal Input:: +* Simple File I/O:: @end menu @node Terminal Output @@ -284,25 +284,25 @@ @DOCSTRING(stderr) @menu -* Opening and Closing Files:: -* Simple Output:: -* Line-Oriented Input:: -* Formatted Output:: -* Output Conversion for Matrices:: -* Output Conversion Syntax:: -* Table of Output Conversions:: -* Integer Conversions:: +* Opening and Closing Files:: +* Simple Output:: +* Line-Oriented Input:: +* Formatted Output:: +* Output Conversion for Matrices:: +* Output Conversion Syntax:: +* Table of Output Conversions:: +* Integer Conversions:: * Floating-Point Conversions:: -* Other Output Conversions:: -* Formatted Input:: -* Input Conversion Syntax:: -* Table of Input Conversions:: -* Numeric Input Conversions:: -* String Input Conversions:: -* Binary I/O:: -* Temporary Files:: -* EOF and Errors:: -* File Positioning:: +* Other Output Conversions:: +* Formatted Input:: +* Input Conversion Syntax:: +* Table of Input Conversions:: +* Numeric Input Conversions:: +* String Input Conversions:: +* Binary I/O:: +* Temporary Files:: +* EOF and Errors:: +* File Positioning:: @end menu @node Opening and Closing Files @@ -1008,7 +1008,7 @@ @DOCSTRING(tmpnam) -@node EOF and Errors, File Positioning, Temporary Files, C-Style I/O Functions +@node EOF and Errors @subsection End of File and Errors Once a file has been opened its status can be acquired. As an example
--- a/doc/interpreter/java.txi +++ b/doc/interpreter/java.txi @@ -145,7 +145,7 @@ * How to make Java classes available?:: * How to create an instance of a Java class?:: * How can I handle memory limitations?:: -* Which @TeX{} symbols are implemented in the dialog functions?:: +* Which @TeX{} symbols are implemented in dialog functions?:: @end menu @c ------------------------------------------------------------------------ @@ -385,8 +385,8 @@ @seealso{javamem} @c ------------------------------------------------------------------------ -@node Which @TeX{} symbols are implemented in the dialog functions? -@subsection Which @TeX{} symbols are implemented in the dialog functions? +@node Which @TeX{} symbols are implemented in dialog functions? +@subsection Which @TeX{} symbols are implemented in dialog functions? @c - index - @cindex symbols, translation table @cindex @TeX{} symbols, translation table
--- a/doc/interpreter/linalg.txi +++ b/doc/interpreter/linalg.txi @@ -26,9 +26,9 @@ @menu * Techniques Used for Linear Algebra:: -* Basic Matrix Functions:: -* Matrix Factorizations:: -* Functions of a Matrix:: +* Basic Matrix Functions:: +* Matrix Factorizations:: +* Functions of a Matrix:: * Specialized Solvers:: @end menu
--- a/doc/interpreter/matrix.txi +++ b/doc/interpreter/matrix.txi @@ -27,10 +27,10 @@ lower-triangular parts, or sort the columns of a matrix. @menu -* Finding Elements and Checking Conditions:: -* Rearranging Matrices:: -* Special Utility Matrices:: -* Famous Matrices:: +* Finding Elements and Checking Conditions:: +* Rearranging Matrices:: +* Special Utility Matrices:: +* Famous Matrices:: @end menu @node Finding Elements and Checking Conditions
--- a/doc/interpreter/nonlin.txi +++ b/doc/interpreter/nonlin.txi @@ -23,7 +23,7 @@ @menu * Solvers:: -* Minimizers:: +* Minimizers:: @end menu @node Solvers
--- a/doc/interpreter/numbers.txi +++ b/doc/interpreter/numbers.txi @@ -93,9 +93,9 @@ * Single Precision Data Types:: * Integer Data Types:: * Bit Manipulations:: -* Logical Values:: +* Logical Values:: * Promotion and Demotion of Data Types:: -* Predicates for Numeric Objects:: +* Predicates for Numeric Objects:: @end menu @node Matrices @@ -304,7 +304,7 @@ @DOCSTRING(fixed_point_format) @menu -* Empty Matrices:: +* Empty Matrices:: @end menu @node Empty Matrices
--- a/doc/interpreter/octave.texi +++ b/doc/interpreter/octave.texi @@ -203,75 +203,75 @@ Preface -* Acknowledgements:: +* Acknowledgements:: * Citing Octave in Publications:: -* How You Can Contribute to Octave:: -* Distribution:: +* How You Can Contribute to Octave:: +* Distribution:: Introduction -* Running Octave:: -* Simple Examples:: -* Conventions:: +* Running Octave:: +* Simple Examples:: +* Conventions:: Conventions -* Fonts:: -* Evaluation Notation:: -* Printing Notation:: -* Error Messages:: -* Format of Descriptions:: +* Fonts:: +* Evaluation Notation:: +* Printing Notation:: +* Error Messages:: +* Format of Descriptions:: Format of Descriptions -* A Sample Function Description:: -* A Sample Command Description:: +* A Sample Function Description:: +* A Sample Command Description:: Getting Started -* Invoking Octave from the Command Line:: -* Quitting Octave:: -* Getting Help:: -* Command Line Editing:: -* Errors:: -* Executable Octave Programs:: -* Comments:: +* Invoking Octave from the Command Line:: +* Quitting Octave:: +* Getting Help:: +* Command Line Editing:: +* Errors:: +* Executable Octave Programs:: +* Comments:: Invoking Octave from the Command Line -* Command Line Options:: -* Startup Files:: +* Command Line Options:: +* Startup Files:: Command Line Editing -* Cursor Motion:: -* Killing and Yanking:: -* Commands For Text:: -* Commands For Completion:: -* Commands For History:: -* Customizing readline:: -* Customizing the Prompt:: -* Diary and Echo Commands:: +* Cursor Motion:: +* Killing and Yanking:: +* Commands For Text:: +* Commands For Completion:: +* Commands For History:: +* Customizing readline:: +* Customizing the Prompt:: +* Diary and Echo Commands:: Comments * Single Line Comments:: * Block Comments:: -* Comments and the Help System:: +* Comments and the Help System:: Data Types -* Built-in Data Types:: -* User-defined Data Types:: -* Object Sizes:: +* Built-in Data Types:: +* User-defined Data Types:: +* Object Sizes:: Built-in Data Types -* Numeric Objects:: -* Missing Data:: -* String Objects:: -* Data Structure Objects:: -* Cell Array Objects:: +* Numeric Objects:: +* Missing Data:: +* String Objects:: +* Data Structure Objects:: +* Cell Array Objects:: Numeric Data Types @@ -280,13 +280,13 @@ * Single Precision Data Types:: * Integer Data Types:: * Bit Manipulations:: -* Logical Values:: +* Logical Values:: * Promotion and Demotion of Data Types:: -* Predicates for Numeric Objects:: +* Predicates for Numeric Objects:: Matrices -* Empty Matrices:: +* Empty Matrices:: Integer Data Types @@ -296,16 +296,16 @@ * Escape Sequences in String Constants:: * Character Arrays:: -* Creating Strings:: -* Comparing Strings:: -* Manipulating Strings:: -* String Conversions:: -* Character Class Functions:: +* Creating Strings:: +* Comparing Strings:: +* Manipulating Strings:: +* String Conversions:: +* Character Class Functions:: Creating Strings -* Concatenating Strings:: -* Conversion of Numerical Data to Strings:: +* Concatenating Strings:: +* Converting Numerical Data to Strings:: Data Containers @@ -336,20 +336,20 @@ Variables -* Global Variables:: -* Persistent Variables:: -* Status of Variables:: +* Global Variables:: +* Persistent Variables:: +* Status of Variables:: Expressions -* Index Expressions:: -* Calling Functions:: -* Arithmetic Ops:: -* Comparison Ops:: -* Boolean Expressions:: -* Assignment Ops:: -* Increment Ops:: -* Operator Precedence:: +* Index Expressions:: +* Calling Functions:: +* Arithmetic Ops:: +* Comparison Ops:: +* Boolean Expressions:: +* Assignment Ops:: +* Increment Ops:: +* Operator Precedence:: Index Expressions @@ -357,13 +357,13 @@ Calling Functions -* Call by Value:: -* Recursion:: +* Call by Value:: +* Recursion:: Boolean Expressions -* Element-by-element Boolean Operators:: -* Short-circuit Boolean Operators:: +* Element-by-element Boolean Operators:: +* Short-circuit Boolean Operators:: Evaluation @@ -372,40 +372,40 @@ Statements -* The if Statement:: -* The switch Statement:: -* The while Statement:: -* The do-until Statement:: -* The for Statement:: -* The break Statement:: -* The continue Statement:: -* The unwind_protect Statement:: -* The try Statement:: -* Continuation Lines:: +* The if Statement:: +* The switch Statement:: +* The while Statement:: +* The do-until Statement:: +* The for Statement:: +* The break Statement:: +* The continue Statement:: +* The unwind_protect Statement:: +* The try Statement:: +* Continuation Lines:: The switch Statement -* Notes for the C Programmer:: +* Notes for the C Programmer:: The for Statement -* Looping Over Structure Elements:: +* Looping Over Structure Elements:: Functions and Scripts * Introduction to Function and Script Files:: -* Defining Functions:: -* Multiple Return Values:: -* Variable-length Argument Lists:: -* Ignoring Arguments:: -* Variable-length Return Lists:: -* Returning from a Function:: -* Default Arguments:: -* Function Files:: -* Script Files:: -* Function Handles Inline Functions and Anonymous Functions:: +* Defining Functions:: +* Multiple Return Values:: +* Variable-length Argument Lists:: +* Ignoring Arguments:: +* Variable-length Return Lists:: +* Returning from a Function:: +* Default Arguments:: +* Function Files:: +* Script Files:: +* Function Handles Anonymous Functions Inline Functions:: * Commands:: -* Organization of Functions:: +* Organization of Functions:: Function Files @@ -417,7 +417,7 @@ * Function Locking:: * Function Precedence:: -Function Handles Inline Functions and Anonymous Functions +Function Handles Anonymous Functions Inline Functions * Function Handles:: * Anonymous Functions:: @@ -451,14 +451,14 @@ Input and Output -* Basic Input and Output:: -* C-Style I/O Functions:: +* Basic Input and Output:: +* C-Style I/O Functions:: Basic Input and Output -* Terminal Output:: -* Terminal Input:: -* Simple File I/O:: +* Terminal Output:: +* Terminal Input:: +* Simple File I/O:: Terminal Output @@ -470,130 +470,130 @@ C-Style I/O Functions -* Opening and Closing Files:: -* Simple Output:: -* Line-Oriented Input:: -* Formatted Output:: -* Output Conversion for Matrices:: -* Output Conversion Syntax:: -* Table of Output Conversions:: -* Integer Conversions:: +* Opening and Closing Files:: +* Simple Output:: +* Line-Oriented Input:: +* Formatted Output:: +* Output Conversion for Matrices:: +* Output Conversion Syntax:: +* Table of Output Conversions:: +* Integer Conversions:: * Floating-Point Conversions:: -* Other Output Conversions:: -* Formatted Input:: -* Input Conversion Syntax:: -* Table of Input Conversions:: -* Numeric Input Conversions:: -* String Input Conversions:: -* Binary I/O:: -* Temporary Files:: -* EOF and Errors:: -* File Positioning:: +* Other Output Conversions:: +* Formatted Input:: +* Input Conversion Syntax:: +* Table of Input Conversions:: +* Numeric Input Conversions:: +* String Input Conversions:: +* Binary I/O:: +* Temporary Files:: +* EOF and Errors:: +* File Positioning:: Plotting -* Introduction to Plotting:: -* High-Level Plotting:: -* Graphics Data Structures:: -* Advanced Plotting:: +* Introduction to Plotting:: +* High-Level Plotting:: +* Graphics Data Structures:: +* Advanced Plotting:: High-Level Plotting -* Two-Dimensional Plots:: -* Three-Dimensional Plots:: -* Plot Annotations:: -* Multiple Plots on One Page:: -* Multiple Plot Windows:: +* Two-Dimensional Plots:: +* Three-Dimensional Plots:: +* Plot Annotations:: +* Multiple Plots on One Page:: +* Multiple Plot Windows:: * Manipulation of Plot Windows:: * Use of the @code{interpreter} Property:: -* Printing and Saving Plots:: -* Interacting with Plots:: -* Test Plotting Functions:: +* Printing and Saving Plots:: +* Interacting with Plots:: +* Test Plotting Functions:: Two-Dimensional Plots -* Axis Configuration:: -* Two-dimensional Function Plotting:: -* Two-dimensional Geometric Shapes:: +* Axis Configuration:: +* Two-dimensional Function Plotting:: +* Two-dimensional Geometric Shapes:: Three-Dimensional Plots * Aspect Ratio:: -* Three-dimensional Function Plotting:: -* Three-dimensional Geometric Shapes:: +* Three-dimensional Function Plotting:: +* Three-dimensional Geometric Shapes:: Graphics Data Structures -* Introduction to Graphics Structures:: -* Graphics Objects:: -* Graphics Object Properties:: -* Searching Properties:: -* Managing Default Properties:: +* Introduction to Graphics Structures:: +* Graphics Objects:: +* Graphics Object Properties:: +* Searching Properties:: +* Managing Default Properties:: Graphics Object Properties -* Root Figure Properties:: -* Figure Properties:: -* Axes Properties:: -* Line Properties:: -* Text Properties:: -* Image Properties:: -* Patch Properties:: -* Surface Properties:: +* Root Figure Properties:: +* Figure Properties:: +* Axes Properties:: +* Line Properties:: +* Text Properties:: +* Image Properties:: +* Patch Properties:: +* Surface Properties:: Advanced Plotting -* Colors:: -* Line Styles:: -* Marker Styles:: -* Callbacks:: +* Colors:: +* Line Styles:: +* Marker Styles:: +* Callbacks:: * Application-defined Data:: -* Object Groups:: -* Graphics Toolkits:: +* Object Groups:: +* Graphics Toolkits:: Object Groups -* Data Sources in Object Groups:: -* Area Series:: -* Bar Series:: -* Contour Groups:: -* Error Bar Series:: -* Line Series:: -* Quiver Group:: -* Scatter Group:: -* Stair Group:: -* Stem Series:: -* Surface Group:: +* Data Sources in Object Groups:: +* Area Series:: +* Bar Series:: +* Contour Groups:: +* Error Bar Series:: +* Line Series:: +* Quiver Group:: +* Scatter Group:: +* Stair Group:: +* Stem Series:: +* Surface Group:: Graphics Toolkits -* Customizing Toolkit Behavior:: +* Customizing Toolkit Behavior:: Matrix Manipulation -* Finding Elements and Checking Conditions:: -* Rearranging Matrices:: -* Special Utility Matrices:: -* Famous Matrices:: +* Finding Elements and Checking Conditions:: +* Rearranging Matrices:: +* Special Utility Matrices:: +* Famous Matrices:: Arithmetic * Exponents and Logarithms:: -* Complex Arithmetic:: -* Trigonometry:: -* Sums and Products:: -* Utility Functions:: -* Special Functions:: +* Complex Arithmetic:: +* Trigonometry:: +* Sums and Products:: +* Utility Functions:: +* Special Functions:: * Rational Approximations:: * Coordinate Transformations:: -* Mathematical Constants:: +* Mathematical Constants:: Linear Algebra * Techniques Used for Linear Algebra:: -* Basic Matrix Functions:: -* Matrix Factorizations:: -* Functions of a Matrix:: +* Basic Matrix Functions:: +* Matrix Factorizations:: +* Functions of a Matrix:: * Specialized Solvers:: Vectorization and Faster Code Execution @@ -609,15 +609,15 @@ Nonlinear Equations * Solvers:: -* Minimizers:: +* Minimizers:: Diagonal and Permutation Matrices -* Basic Usage:: Creation and Manipulation of Diagonal and Permutation Matrices -* Matrix Algebra:: Linear Algebra with Diagonal and Permutation Matrices +* Basic Usage:: Creation and Manipulation of Diagonal/Permutation Matrices +* Matrix Algebra:: Linear Algebra with Diagonal/Permutation Matrices * Function Support:: Functions That Are Aware of These Matrices -* Example Code:: Some Examples of Usage -* Zeros Treatment:: The Differences in Treatment of Zero Elements +* Example Code:: Examples of Usage +* Zeros Treatment:: Differences in Treatment of Zero Elements Basic Usage @@ -651,37 +651,37 @@ Operators and Functions -* Sparse Functions:: -* Return Types of Operators and Functions:: -* Mathematical Considerations:: +* Sparse Functions:: +* Return Types of Operators and Functions:: +* Mathematical Considerations:: Numerical Integration -* Functions of One Variable:: -* Orthogonal Collocation:: -* Functions of Multiple Variables:: +* Functions of One Variable:: +* Orthogonal Collocation:: +* Functions of Multiple Variables:: Differential Equations -* Ordinary Differential Equations:: -* Differential-Algebraic Equations:: +* Ordinary Differential Equations:: +* Differential-Algebraic Equations:: Optimization -* Linear Programming:: -* Quadratic Programming:: -* Nonlinear Programming:: -* Linear Least Squares:: +* Linear Programming:: +* Quadratic Programming:: +* Nonlinear Programming:: +* Linear Least Squares:: Statistics * Descriptive Statistics:: -* Basic Statistical Functions:: -* Statistical Plots:: -* Correlation and Regression Analysis:: -* Distributions:: -* Tests:: -* Random Number Generation:: +* Basic Statistical Functions:: +* Statistical Plots:: +* Correlation and Regression Analysis:: +* Distributions:: +* Tests:: +* Random Number Generation:: Sets @@ -715,11 +715,11 @@ Image Processing -* Loading and Saving Images:: -* Displaying Images:: -* Representing Images:: -* Plotting on top of Images:: -* Color Conversion:: +* Loading and Saving Images:: +* Displaying Images:: +* Representing Images:: +* Plotting on top of Images:: +* Color Conversion:: Object Oriented Programming @@ -742,24 +742,24 @@ GUI Development -* I/O Dialogs:: -* Progress Bar:: -* GUI Utility Functions:: -* User-Defined Preferences:: +* I/O Dialogs:: +* Progress Bar:: +* GUI Utility Functions:: +* User-Defined Preferences:: System Utilities -* Timing Utilities:: -* Filesystem Utilities:: +* Timing Utilities:: +* Filesystem Utilities:: * File Archiving Utilities:: * Networking Utilities:: -* Controlling Subprocesses:: -* Process ID Information:: -* Environment Variables:: -* Current Working Directory:: -* Password Database Functions:: -* Group Database Functions:: -* System Information:: +* Controlling Subprocesses:: +* Process ID Information:: +* Environment Variables:: +* Current Working Directory:: +* Password Database Functions:: +* Group Database Functions:: +* System Information:: * Hashing Functions:: Networking Utilities @@ -780,58 +780,58 @@ * How to make Java classes available?:: * How to create an instance of a Java class?:: * How can I handle memory limitations?:: -* Which @TeX{} symbols are implemented in the dialog functions?:: +* Which @TeX{} symbols are implemented in dialog functions?:: Packages -* Installing and Removing Packages:: -* Using Packages:: -* Administrating Packages:: -* Creating Packages:: +* Installing and Removing Packages:: +* Using Packages:: +* Administrating Packages:: +* Creating Packages:: Creating Packages -* The DESCRIPTION File:: -* The INDEX File:: -* PKG_ADD and PKG_DEL Directives:: +* The DESCRIPTION File:: +* The INDEX File:: +* PKG_ADD and PKG_DEL Directives:: External Code Interface -* Oct-Files:: -* Mex-Files:: -* Standalone Programs:: +* Oct-Files:: +* Mex-Files:: +* Standalone Programs:: Oct-Files -* Getting Started with Oct-Files:: -* Matrices and Arrays in Oct-Files:: -* Character Strings in Oct-Files:: -* Cell Arrays in Oct-Files:: -* Structures in Oct-Files:: -* Sparse Matrices in Oct-Files:: -* Accessing Global Variables in Oct-Files:: -* Calling Octave Functions from Oct-Files:: -* Calling External Code from Oct-Files:: -* Allocating Local Memory in Oct-Files:: -* Input Parameter Checking in Oct-Files:: -* Exception and Error Handling in Oct-Files:: -* Documentation and Test of Oct-Files:: +* Getting Started with Oct-Files:: +* Matrices and Arrays in Oct-Files:: +* Character Strings in Oct-Files:: +* Cell Arrays in Oct-Files:: +* Structures in Oct-Files:: +* Sparse Matrices in Oct-Files:: +* Accessing Global Variables in Oct-Files:: +* Calling Octave Functions from Oct-Files:: +* Calling External Code from Oct-Files:: +* Allocating Local Memory in Oct-Files:: +* Input Parameter Checking in Oct-Files:: +* Exception and Error Handling in Oct-Files:: +* Documentation and Test of Oct-Files:: Sparse Matrices in Oct-Files -* Array and Sparse Differences:: -* Creating Sparse Matrices in Oct-Files:: -* Using Sparse Matrices in Oct-Files:: +* Array and Sparse Class Differences:: +* Creating Sparse Matrices in Oct-Files:: +* Using Sparse Matrices in Oct-Files:: Mex-Files -* Getting Started with Mex-Files:: -* Working with Matrices and Arrays in Mex-Files:: -* Character Strings in Mex-Files:: -* Cell Arrays with Mex-Files:: -* Structures with Mex-Files:: -* Sparse Matrices with Mex-Files:: -* Calling Other Functions in Mex-Files:: +* Getting Started with Mex-Files:: +* Working with Matrices and Arrays in Mex-Files:: +* Character Strings in Mex-Files:: +* Cell Arrays with Mex-Files:: +* Structures with Mex-Files:: +* Sparse Matrices with Mex-Files:: +* Calling Other Functions in Mex-Files:: Test and Demo Functions @@ -858,12 +858,12 @@ Trouble * Actual Bugs:: Bugs we will fix later. -* Reporting Bugs:: -* Service:: +* Reporting Bugs:: +* Service:: Reporting Bugs -* Bug Criteria:: +* Bug Criteria:: * Bug Tracker:: Where to submit your bug report. * Bug Reporting:: How to report a bug effectively. * Sending Patches:: How to send a patch for Octave. @@ -883,15 +883,15 @@ Emacs Octave Support -* Installing EOS:: -* Using Octave Mode:: -* Running Octave from Within Emacs:: -* Using the Emacs Info Reader for Octave:: +* Installing EOS:: +* Using Octave Mode:: +* Running Octave from Within Emacs:: +* Using the Emacs Info Reader for Octave:: Grammar and Parser -* Keywords:: -* Parser:: +* Keywords:: +* Parser:: @end detailmenu @end menu
--- a/doc/interpreter/optim.txi +++ b/doc/interpreter/optim.txi @@ -25,10 +25,10 @@ Minimization. @menu -* Linear Programming:: -* Quadratic Programming:: -* Nonlinear Programming:: -* Linear Least Squares:: +* Linear Programming:: +* Quadratic Programming:: +* Nonlinear Programming:: +* Linear Least Squares:: @end menu @c @cindex linear programming
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -22,10 +22,10 @@ @cindex graphics @menu -* Introduction to Plotting:: -* High-Level Plotting:: -* Graphics Data Structures:: -* Advanced Plotting:: +* Introduction to Plotting:: +* High-Level Plotting:: +* Graphics Data Structures:: +* Advanced Plotting:: @end menu @node Introduction to Plotting @@ -57,25 +57,25 @@ and @ref{Advanced Plotting}. @menu -* Two-Dimensional Plots:: -* Three-Dimensional Plots:: -* Plot Annotations:: -* Multiple Plots on One Page:: -* Multiple Plot Windows:: +* Two-Dimensional Plots:: +* Three-Dimensional Plots:: +* Plot Annotations:: +* Multiple Plots on One Page:: +* Multiple Plot Windows:: * Manipulation of Plot Windows:: * Use of the @code{interpreter} Property:: -* Printing and Saving Plots:: -* Interacting with Plots:: -* Test Plotting Functions:: +* Printing and Saving Plots:: +* Interacting with Plots:: +* Test Plotting Functions:: @end menu @node Two-Dimensional Plots @subsection Two-Dimensional Plots @menu -* Axis Configuration:: -* Two-dimensional Function Plotting:: -* Two-dimensional Geometric Shapes:: +* Axis Configuration:: +* Two-dimensional Function Plotting:: +* Two-dimensional Geometric Shapes:: @end menu The @code{plot} function allows you to create simple x-y plots with @@ -398,8 +398,8 @@ @menu * Aspect Ratio:: -* Three-dimensional Function Plotting:: -* Three-dimensional Geometric Shapes:: +* Three-dimensional Function Plotting:: +* Three-dimensional Geometric Shapes:: @end menu @node Aspect Ratio @@ -888,11 +888,11 @@ @cindex graphics data structures @menu -* Introduction to Graphics Structures:: -* Graphics Objects:: -* Graphics Object Properties:: -* Searching Properties:: -* Managing Default Properties:: +* Introduction to Graphics Structures:: +* Graphics Objects:: +* Graphics Object Properties:: +* Searching Properties:: +* Managing Default Properties:: @end menu @node Introduction to Graphics Structures @@ -1205,14 +1205,14 @@ @cindex graphics object properties @menu -* Root Figure Properties:: -* Figure Properties:: -* Axes Properties:: -* Line Properties:: -* Text Properties:: -* Image Properties:: -* Patch Properties:: -* Surface Properties:: +* Root Figure Properties:: +* Figure Properties:: +* Axes Properties:: +* Line Properties:: +* Text Properties:: +* Image Properties:: +* Patch Properties:: +* Surface Properties:: @end menu In this Section the object properties are discussed in detail, starting @@ -2528,13 +2528,13 @@ @menu -* Colors:: -* Line Styles:: -* Marker Styles:: -* Callbacks:: +* Colors:: +* Line Styles:: +* Marker Styles:: +* Callbacks:: * Application-defined Data:: -* Object Groups:: -* Graphics Toolkits:: +* Object Groups:: +* Graphics Toolkits:: @end menu @@ -2686,7 +2686,7 @@ function described below. @node Application-defined Data -@subsection Application-defined Data +@subsection Application-defined Data @cindex application-defined data Octave has a provision for attaching application-defined data to a graphics @@ -2829,17 +2829,17 @@ corresponding hggroup elements. @menu -* Data Sources in Object Groups:: -* Area Series:: -* Bar Series:: -* Contour Groups:: -* Error Bar Series:: -* Line Series:: -* Quiver Group:: -* Scatter Group:: -* Stair Group:: -* Stem Series:: -* Surface Group:: +* Data Sources in Object Groups:: +* Area Series:: +* Bar Series:: +* Contour Groups:: +* Error Bar Series:: +* Line Series:: +* Quiver Group:: +* Scatter Group:: +* Stair Group:: +* Stem Series:: +* Surface Group:: @end menu @node Data Sources in Object Groups @@ -3336,7 +3336,7 @@ @DOCSTRING(register_graphics_toolkit) @menu -* Customizing Toolkit Behavior:: +* Customizing Toolkit Behavior:: @end menu @node Customizing Toolkit Behavior
--- a/doc/interpreter/preface.txi +++ b/doc/interpreter/preface.txi @@ -63,10 +63,10 @@ you may have. @menu -* Acknowledgements:: +* Acknowledgements:: * Citing Octave in Publications:: -* How You Can Contribute to Octave:: -* Distribution:: +* How You Can Contribute to Octave:: +* Distribution:: @end menu @node Acknowledgements
--- a/doc/interpreter/quad.txi +++ b/doc/interpreter/quad.txi @@ -24,9 +24,9 @@ 1-dimensional integration problems. @menu -* Functions of One Variable:: -* Orthogonal Collocation:: -* Functions of Multiple Variables:: +* Functions of One Variable:: +* Orthogonal Collocation:: +* Functions of Multiple Variables:: @end menu @node Functions of One Variable
--- a/doc/interpreter/sparse.txi +++ b/doc/interpreter/sparse.txi @@ -23,7 +23,7 @@ @set htmltex @end iftex -@node Sparse Matrices +@node Sparse Matrices @chapter Sparse Matrices @menu @@ -34,7 +34,7 @@ @end menu @node Basics -@section The Creation and Manipulation of Sparse Matrices +@section Creation and Manipulation of Sparse Matrices The size of mathematical problems that can be treated at any particular time is generally limited by the available computing resources. Both, @@ -311,7 +311,7 @@ for a a full description of the techniques involved. @node Information -@subsection Finding out Information about Sparse Matrices +@subsection Finding Information about Sparse Matrices There are a number of functions that allow information concerning sparse matrices to be obtained. The most basic of these is @@ -442,9 +442,9 @@ @subsection Basic Operators and Functions on Sparse Matrices @menu -* Sparse Functions:: -* Return Types of Operators and Functions:: -* Mathematical Considerations:: +* Sparse Functions:: +* Return Types of Operators and Functions:: +* Mathematical Considerations:: @end menu @node Sparse Functions @@ -504,7 +504,7 @@ details. @node Return Types of Operators and Functions -@subsubsection The Return Types of Operators and Functions +@subsubsection Return Types of Operators and Functions The two basic reasons to use sparse matrices are to reduce the memory usage and to not have to do calculations on zero elements. The two are @@ -855,7 +855,7 @@ @DOCSTRING(svds) @node Iterative Techniques -@section Iterative Techniques applied to sparse matrices +@section Iterative Techniques Applied to Sparse Matrices The left division @code{\} and right division @code{/} operators, discussed in the previous section, use direct solvers to resolve a @@ -876,7 +876,7 @@ @DOCSTRING(luinc) @node Real Life Example -@section Real Life Example of the use of Sparse Matrices +@section Real Life Example using Sparse Matrices A common application for sparse matrices is in the solution of Finite Element Models. Finite element models allow numerical solution of
--- a/doc/interpreter/stats.txi +++ b/doc/interpreter/stats.txi @@ -47,12 +47,12 @@ @menu * Descriptive Statistics:: -* Basic Statistical Functions:: -* Statistical Plots:: -* Correlation and Regression Analysis:: -* Distributions:: -* Tests:: -* Random Number Generation:: +* Basic Statistical Functions:: +* Statistical Plots:: +* Correlation and Regression Analysis:: +* Distributions:: +* Tests:: +* Random Number Generation:: @end menu @node Descriptive Statistics
--- a/doc/interpreter/stmt.txi +++ b/doc/interpreter/stmt.txi @@ -46,16 +46,16 @@ @dfn{body} of a control statement. @menu -* The if Statement:: -* The switch Statement:: -* The while Statement:: -* The do-until Statement:: -* The for Statement:: -* The break Statement:: -* The continue Statement:: -* The unwind_protect Statement:: -* The try Statement:: -* Continuation Lines:: +* The if Statement:: +* The switch Statement:: +* The while Statement:: +* The do-until Statement:: +* The for Statement:: +* The break Statement:: +* The continue Statement:: +* The unwind_protect Statement:: +* The try Statement:: +* Continuation Lines:: @end menu @node The if Statement @@ -328,7 +328,7 @@ @end example @menu -* Notes for the C Programmer:: +* Notes for the C Programmer:: @end menu @node Notes for the C Programmer @@ -601,7 +601,7 @@ something to do inside the loop. @menu -* Looping Over Structure Elements:: +* Looping Over Structure Elements:: @end menu @node Looping Over Structure Elements
--- a/doc/interpreter/strings.txi +++ b/doc/interpreter/strings.txi @@ -56,11 +56,11 @@ @menu * Escape Sequences in String Constants:: * Character Arrays:: -* Creating Strings:: -* Comparing Strings:: -* Manipulating Strings:: -* String Conversions:: -* Character Class Functions:: +* Creating Strings:: +* Comparing Strings:: +* Manipulating Strings:: +* String Conversions:: +* Character Class Functions:: @end menu @node Escape Sequences in String Constants @@ -222,8 +222,8 @@ @DOCSTRING(blanks) @menu -* Concatenating Strings:: -* Conversion of Numerical Data to Strings:: +* Concatenating Strings:: +* Converting Numerical Data to Strings:: @end menu @node Concatenating Strings @@ -359,8 +359,8 @@ @DOCSTRING(cstrcat) -@node Conversion of Numerical Data to Strings -@subsection Conversion of Numerical Data to Strings +@node Converting Numerical Data to Strings +@subsection Converting Numerical Data to Strings Apart from the string concatenation functions (@pxref{Concatenating Strings}) which cast numerical data to the corresponding ASCII characters, there are several functions that format numerical data as strings. @code{mat2str} and
--- a/doc/interpreter/system.txi +++ b/doc/interpreter/system.txi @@ -26,17 +26,17 @@ and even start other programs from the Octave prompt. @menu -* Timing Utilities:: -* Filesystem Utilities:: +* Timing Utilities:: +* Filesystem Utilities:: * File Archiving Utilities:: * Networking Utilities:: -* Controlling Subprocesses:: -* Process ID Information:: -* Environment Variables:: -* Current Working Directory:: -* Password Database Functions:: -* Group Database Functions:: -* System Information:: +* Controlling Subprocesses:: +* Process ID Information:: +* Environment Variables:: +* Current Working Directory:: +* Password Database Functions:: +* Group Database Functions:: +* System Information:: * Hashing Functions:: @end menu