octave: libinterp/op-kw-docs annotate

annotate libinterp/op-kw-docs @ 28517:6e8a9845d118

Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). * op-kw-docs: Document 'spmd', 'endspmd' keywords. * lex.ll (base_lexer::make_keyword_token): Add case statements for 'spmd', 'endspmd'. Code is not correct, but something is required to prevent segfault. * oct-parse.yy: Add SPMD token type. * oct-parse.yy (end_token_as_string): Add case statement for 'endspmd'. * octave.gperf: Add endspmd_kw, spmd_kw to enum octave_kw_id. Add declarations to octave_kw struct for endspmd, spmd. * token.h: Add spmd_end to enm end_tok_type.

author	Rik <rik@octave.org>
date	Tue, 30 Jun 2020 09:34:14 -0700
parents	bd51beb6205e
children	7854d5752dd2

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 ## Copyright (C) 1993-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26778 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	7 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	8 ## This file is part of Octave.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	13 ## (at your option) any later version.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	14 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	18 ## GNU General Public License for more details.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	19 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	25
26778 8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	26 ## FIXME: Can't have duplicate DOCSTRING entries. The function properties
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	27 ## already has a docstring which overrides this keyword definition.
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	28 ## If this is ever fixed this entry can be re-inserted after the
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	29 ## keyword "persistent".
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	30 ## properties
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	31 ## libinterp/parse-tree/oct-parse.yy
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	32 ## -- texinfo --
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	33 ## @deftypefn {} {} properties
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	34 ## Begin a properties block in a classdef definition.
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	35 ## @end deftypefn
8cad08868ffd Return help text for properties() function (bug #55764). Rik <rik@octave.org> parents: 26723 diff changeset	36
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	37 !
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	38 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	39 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	40 @deftypefn {} {} !
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	41 Logical 'not' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	42 @seealso{~, not}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	43 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	44 ~
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	45 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	46 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	47 @deftypefn {} {} ~
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	48 Logical 'not' operator.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	49
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	50 The symbol may also be used to discard outputs of a function that are unwanted
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	51 without using a temporary variable.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	52
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	53 @example
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	54 [~, @var{idx_of_max}] = max (@var{x})
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	55 @end example
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	56 @seealso{!, not}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	57 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	58 !=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	59 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	60 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	61 @deftypefn {} {} !=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	62 Logical 'not equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	63 @seealso{~=, ne}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	64 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	65 ~=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	66 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	67 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	68 @deftypefn {} {} ~=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	69 Logical 'not equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	70 @seealso{!=, ne}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	71 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	72 "
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	73 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	74 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	75 @deftypefn {} {} "
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	76 String delimiter.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	77
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	78 Escape sequences within double-quoted strings are expanded. I.e., "\n" is a
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	79 1-character string representing a newline. See the single quote delimiter (')
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	80 to create strings without escape sequence processing.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	81 @seealso{'}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	82 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	83 #
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	84 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	85 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	86 @deftypefn {} {} #
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	87 Begin comment character.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	88 @seealso{%, #@\{}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	89 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	90 %
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	91 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	92 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	93 @deftypefn {} {} %
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	94 Begin comment character.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	95 @seealso{#, %@\{}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	96 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	97 #{
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	98 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	99 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	100 @deftypefn {} {} #@{
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	101 Begin block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	102
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	103 There must be no other characters, other than whitespace, on the line before
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	104 and after @code{#@{}. It is possible to nest block comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	105 @seealso{%@\{, #@\}, #}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	106 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	107 %{
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	108 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	109 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	110 @deftypefn {} {} %@{
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	111 Begin block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	112
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	113 There must be no other characters, other than whitespace, on the line before
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	114 and after @code{%@{}. It is possible to nest block comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	115 @seealso{#@\{, %@\}, %}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	116 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	117 #}
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	118 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	119 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	120 @deftypefn {} {} #@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	121 Close block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	122
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	123 There must be no other characters, other than whitespace, on the line before
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	124 and after @code{#@}}. It is possible to nest block comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	125 @seealso{%@\}, #@\{, #}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	126 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	127 %}
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	128 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	129 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	130 @deftypefn {} {} %@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	131 Close block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	132
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	133 There must be no other characters, other than whitespace, on the line before
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	134 and after @code{%@}}. It is possible to nest block comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	135 @seealso{#@\}, %@\{, %}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	136 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	137 ...
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	138 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	139 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	140 @deftypefn {} {} ...
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	141 Continuation marker.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	142
24509 d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	143 Joins current line with following line before parsing.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	144 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	145 &
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	146 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	147 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	148 @deftypefn {} {} &
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	149 Element by element logical 'and' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	150 @seealso{&&, and}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	151 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	152 &&
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	153 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	154 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	155 @deftypefn {} {} &&
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	156 Logical 'and' operator (with short-circuit evaluation).
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	157 @seealso{&, and}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	158 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	159 '
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	160 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	161 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	162 @deftypefn {} {} '
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	163 Matrix transpose operator or string delimiter.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	164
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	165 For complex matrices, computes the complex conjugate (Hermitian) transpose.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	166
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	167 The single quote character may also be used to delimit strings. Escape
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	168 sequences within single-quoted strings are not expanded. I.e., '\n' is a
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	169 2-character string '\' and 'n' rather than "\n" which is a single character
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	170 representing a newline.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	171 @seealso{.', transpose, "}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	172 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	173 (
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	174 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	175 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	176 @deftypefn {} {} (
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	177 Array index or function argument delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	178 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	179 )
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	180 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	181 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	182 @deftypefn {} {})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	183 Array index or function argument delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	184 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	185 *
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	186 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	187 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	188 @deftypefn {} {} *
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	189 Multiplication operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	190 @seealso{.*, times}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	191 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	192 **
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	193 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	194 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	195 @deftypefn {} {} **
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	196 Power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	197
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	198 This may return complex results for real inputs. Use @code{realsqrt},
25642 cf452aa01cd5 doc: Replace instances of realroot (non-existent) with realpow (bug #54336). Rik <rik@octave.org> parents: 25280 diff changeset	199 @code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	200 possible.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	201 @seealso{power, ^, .**, .^, realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	202 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	203 ^
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	204 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	205 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	206 @deftypefn {} {} ^
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	207 Power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	208
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	209 This may return complex results for real inputs. Use @code{realsqrt},
25642 cf452aa01cd5 doc: Replace instances of realroot (non-existent) with realpow (bug #54336). Rik <rik@octave.org> parents: 25280 diff changeset	210 @code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	211 possible.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	212 @seealso{power, , .^, ., realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	213 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	214 +
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	215 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	216 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	217 @deftypefn {} {} +
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	218 Addition operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	219 @seealso{plus}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	220 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	221 ++
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	222 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	223 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	224 @deftypefn {} {} ++
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	225 Increment operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	226
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	227 As in C, may be applied as a prefix or postfix operator.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	228 @seealso{--}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	229 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	230 ,
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	231 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	232 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	233 @deftypefn {} {} ,
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	234 Array index, function argument, or command separator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	235 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	236 -
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	237 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	238 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	239 @deftypefn {} {} -
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	240 Subtraction or unary negation operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	241 @seealso{minus}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	242 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	243 --
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	244 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	245 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	246 @deftypefn {} {} --
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	247 Decrement operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	248
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	249 As in C, may be applied as a prefix or postfix operator.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	250 @seealso{++}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	251 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	252 .'
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	253 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	254 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	255 @deftypefn {} {} .'
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	256 Matrix transpose operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	257
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	258 For complex matrices, computes the transpose, @emph{not} the complex conjugate
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	259 (Hermitian) transpose.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	260 @seealso{', transpose}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	261 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	262 .*
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	263 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	264 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	265 @deftypefn {} {} .*
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	266 Element by element multiplication operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	267 @seealso{*, times}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	268 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	269 .**
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	270 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	271 -- texinfo --
22431 475b4cd1b789 doc: Correct docstring for '.*' operator (bug #48973) Rik <rik@octave.org>* parents: 22430 diff changeset	272 @deftypefn {} {} .**
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	273 Element by element power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	274
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	275 If several complex results are possible, returns the one with smallest
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	276 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	277 @code{cbrt}, or @code{nthroot} if a real result is preferred.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	278 @seealso{**, ^, .^, power, realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	279 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	280 .^
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	281 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	282 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	283 @deftypefn {} {} .^
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	284 Element by element power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	285
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	286 If several complex results are possible, returns the one with smallest
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	287 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	288 @code{cbrt}, or @code{nthroot} if a real result is preferred.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	289 @seealso{., ^, , power, realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	290 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	291 ./
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	292 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	293 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	294 @deftypefn {} {} ./
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	295 Element by element right division operator.
22430 18b863e3b1e2 Properly display help for operators (bug #48975). Rik <rik@octave.org> parents: 22323 diff changeset	296 @seealso{/, .\\, rdivide, mrdivide}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	297 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	298 /
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	299 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	300 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	301 @deftypefn {} {} /
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	302 Right division operator.
22430 18b863e3b1e2 Properly display help for operators (bug #48975). Rik <rik@octave.org> parents: 22323 diff changeset	303 @seealso{./, \\, rdivide, mrdivide}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	304 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	305 .\
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	306 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	307 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	308 @deftypefn {} {} .\
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	309 Element by element left division operator.
22430 18b863e3b1e2 Properly display help for operators (bug #48975). Rik <rik@octave.org> parents: 22323 diff changeset	310 @seealso{\\, ./, rdivide, mrdivide}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	311 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	312 \
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	313 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	314 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	315 @deftypefn {} {} \
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	316 Left division operator.
24509 d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	317
d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	318 Within double-quoted strings, @samp{\} is the line continuation marker used
d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	319 to join the current line with the following line.
22430 18b863e3b1e2 Properly display help for operators (bug #48975). Rik <rik@octave.org> parents: 22323 diff changeset	320 @seealso{.\\, /, ldivide, mldivide}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	321 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	322 :
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	323 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	324 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	325 @deftypefn {} {} :
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	326 Select entire rows or columns of matrices.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	327 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	328 ;
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	329 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	330 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	331 @deftypefn {} {} ;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	332 Array row or command separator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	333 @seealso{,}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	334 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	335 <
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	336 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	337 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	338 @deftypefn {} {} <
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	339 'Less than' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	340 @seealso{lt}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	341 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	342 <=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	343 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	344 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	345 @deftypefn {} {} <=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	346 'Less than' or 'equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	347 @seealso{le}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	348 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	349 =
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	350 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	351 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	352 @deftypefn {} {} =
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	353 Assignment operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	354 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	355 ==
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	356 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	357 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	358 @deftypefn {} {} ==
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	359 Equality test operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	360 @seealso{eq}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	361 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	362 >
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	363 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	364 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	365 @deftypefn {} {} >
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	366 'Greater than' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	367 @seealso{gt}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	368 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	369 >=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	370 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	371 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	372 @deftypefn {} {} >=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	373 'Greater than' or 'equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	374 @seealso{ge}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	375 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	376 [
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	377 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	378 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	379 @deftypefn {} {} [
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	380 Return list delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	381 @seealso{]}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	382 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	383 ]
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	384 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	385 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	386 @deftypefn {} {} ]
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	387 Return list delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	388 @seealso{[}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	389 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	390 \|
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	391 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	392 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	393 @deftypefn {} {} \|
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	394 Element by element logical 'or' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	395 @seealso{\|\|, or}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	396 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	397 \|\|
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	398 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	399 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	400 @deftypefn {} {} \|\|
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	401 Logical 'or' (with short-circuit evaluation) operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	402 @seealso{\|, or}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	403 @end deftypefn
24510 a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	404 @
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	405 @c libinterp/parse-tree/oct-parse.yy
24510 a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	406 -- texinfo --
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	407 @deftypefn {} {} @@
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	408 Return handle to a function.
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	409
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	410 Example:
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	411
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	412 @example
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	413 @group
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	414 f = @@plus;
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	415 f (2, 2)
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	416 @result{} 4
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	417 @end group
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	418 @end example
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	419
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	420 (Note: @@ also finds use in creating classes. See manual chapter titled
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	421 Object Oriented Programming for detailed description.)
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	422 @seealso{function, functions, func2str, str2func}
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	423 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	424 break
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	425 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	426 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	427 @deftypefn {} {} break
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	428 Exit the innermost enclosing do, while, or for loop.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	429 @seealso{do, while, for, parfor, continue}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	430 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	431 case
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	432 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	433 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	434 @deftypefn {} {} case @var{value}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	435 @deftypefnx {} {} case @{@var{value}, @dots{}@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	436 A case statement in a switch block.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	437
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	438 Octave cases are exclusive and do not fall-through as do C-language cases. A
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	439 switch statement must have at least one case. See @code{switch} for an
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	440 example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	441 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	442 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	443 catch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	444 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	445 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	446 @deftypefn {} {} catch
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	447 @deftypefnx {} {} catch @var{value}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	448 Begin the cleanup part of a try-catch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	449 @seealso{try}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	450 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	451 classdef
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	452 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	453 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	454 @deftypefn {} {} classdef
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	455 Begin a classdef block.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	456 @seealso{properties, methods, events, enumeration}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	457 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	458 continue
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	459 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	460 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	461 @deftypefn {} {} continue
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	462 Jump to the end of the innermost enclosing do, while, or for loop.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	463 @seealso{break, do, while, for, parfor}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	464 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	465 do
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	466 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	467 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	468 @deftypefn {} {} do
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	469 Begin a do-until loop.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	470
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	471 This differs from a while loop in that the body of the loop is executed at
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	472 least once.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	473
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	474 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	475 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	476 i = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	477 do
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	478 i++
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	479 until (i == 10)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	480 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	481 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	482 @seealso{for, until, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	483 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	484 else
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	485 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	486 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	487 @deftypefn {} {} else
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	488 Alternate action for an if block. See @code{if} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	489 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	490 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	491 elseif
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	492 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	493 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	494 @deftypefn {} {} elseif (@var{condition})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	495 Alternate conditional test for an if block. See @code{if} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	496 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	497 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	498 end_try_catch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	499 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	500 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	501 @deftypefn {} {} end_try_catch
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	502 Mark the end of a @code{try-catch} block.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	503 @seealso{try, catch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	504 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	505 end_unwind_protect
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	506 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	507 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	508 @deftypefn {} {} end_unwind_protect
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	509 Mark the end of an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	510 @seealso{unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	511 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	512 endclassdef
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	513 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	514 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	515 @deftypefn {} {} endclassdef
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	516 Mark the end of a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	517 @seealso{classdef}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	518 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	519 endenumeration
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	520 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	521 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	522 @deftypefn {} {} endenumeration
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	523 Mark the end of an enumeration block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	524 @seealso{enumeration}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	525 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	526 endevents
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	527 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	528 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	529 @deftypefn {} {} endevents
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	530 Mark the end of an events block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	531 @seealso{events}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	532 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	533 endfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	534 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	535 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	536 @deftypefn {} {} endfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	537 Mark the end of a for loop. See @code{for} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	538 @seealso{for}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	539 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	540 endfunction
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	541 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	542 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	543 @deftypefn {} {} endfunction
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	544 Mark the end of a function.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	545 @seealso{function}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	546 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	547 endif
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	548 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	549 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	550 @deftypefn {} {} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	551 Mark the end of an if block. See @code{if} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	552 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	553 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	554 endmethods
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	555 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	556 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	557 @deftypefn {} {} endmethods
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	558 Mark the end of a methods block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	559 @seealso{methods}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	560 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	561 endparfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	562 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	563 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	564 @deftypefn {} {} endparfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	565 Mark the end of a parfor loop. See @code{parfor} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	566 @seealso{parfor}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	567 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	568 endproperties
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	569 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	570 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	571 @deftypefn {} {} endproperties
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	572 Mark the end of a properties block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	573 @seealso{properties}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	574 @end deftypefn
28517 6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	575 endspmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	576 @c libinterp/parse-tree/oct-parse.yy
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	577 -- texinfo --
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	578 @deftypefn {} {} endparfor
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	579 Mark the end of an spmd block. See @code{spmd} for an example.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	580 @seealso{spmd, parfor}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	581 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	582 endswitch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	583 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	584 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	585 @deftypefn {} {} endswitch
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	586 Mark the end of a switch block. See @code{switch} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	587 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	588 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	589 endwhile
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	590 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	591 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	592 @deftypefn {} {} endwhile
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	593 Mark the end of a while loop. See @code{while} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	594 @seealso{do, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	595 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	596 enumeration
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	597 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	598 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	599 @deftypefn {} {} enumeration
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	600 Begin an enumeration block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	601 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	602 events
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	603 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	604 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	605 @deftypefn {} {} events
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	606 Begin an events block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	607 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	608 for
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	609 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	610 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	611 @deftypefn {} {} for @var{i} = @var{range}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	612 Begin a for loop.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	613
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	614 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	615 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	616 for i = 1:10
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	617 i
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	618 endfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	619 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	620 @end example
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	621 @seealso{parfor, do, while}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	622 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	623 function
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	624 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	625 -- texinfo --
25087 8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	626 @deftypefn {} {} function @var{outputs} = function_name (@var{input}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	627 @deftypefnx {} {} function {} function_name (@var{input}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	628 @deftypefnx {} {} function @var{outputs} = function_name
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	629 Begin a function body with name @code{function_name}, with @var{outputs} as
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	630 results, and with @var{inputs} as parameters. The function can later be
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	631 invoked in Octave using the syntax
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	632
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	633 @example
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	634 [@var{output1}, @var{output2}, @dots{}] = function_name (@var{input1}, @var{input2}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	635 @end example
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	636
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	637 @seealso{return}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	638 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	639 global
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	640 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	641 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	642 @deftypefn {} {} global @var{var}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	643 Declare variables to have global scope.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	644
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	645 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	646 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	647 global @var{x};
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	648 if (isempty (@var{x}))
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	649 x = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	650 endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	651 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	652 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	653 @seealso{persistent}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	654 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	655 if
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	656 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	657 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	658 @deftypefn {} {} if (@var{cond}) @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	659 @deftypefnx {} {} if (@var{cond}) @dots{} else @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	660 @deftypefnx {} {} if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	661 @deftypefnx {} {} if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	662 Begin an if block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	663
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	664 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	665 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	666 x = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	667 if (x == 1)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	668 disp ("one");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	669 elseif (x == 2)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	670 disp ("two");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	671 else
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	672 disp ("not one or two");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	673 endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	674 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	675 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	676 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	677 @end deftypefn
25280 1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	678 @c ## FIXME: Can't have duplicate DOCSTRING entries. The function methods
1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	679 @c ## already has a docstring which overrides this keyword definition.
1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	680 @c #methods
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	681 @c #@c libinterp/parse-tree/oct-parse.yy
25280 1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	682 @c #-- texinfo --
1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	683 @c #@deftypefn {} {} methods
1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	684 @c #Begin a methods block in a classdef definition.
1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	685 @c #@end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	686 otherwise
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	687 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	688 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	689 @deftypefn {} {} otherwise
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	690 The default statement in a switch block which is executed when no other
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	691 case statements match the input.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	692 @seealso{switch, case}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	693 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	694 parfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	695 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	696 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	697 @deftypefn {} {} parfor @var{i} = @var{range}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	698 @deftypefnx {} {} parfor (@var{i} = @var{range}, @var{maxproc})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	699 Begin a for loop that may execute in parallel.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	700
26588 21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	701 A @code{parfor} loop has the same syntax as a @code{for} loop. If your Octave
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	702 session has a parallel processing pool enabled, the iterations of the
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	703 @code{parfor} loop will be executed in parallel across the pool's workers.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	704 Otherwise, @code{parfor} will behave exactly as @code{for}.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	705
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	706 When operating in parallel mode, a @code{parfor} loop's iterations are not
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	707 guaranteed to occur sequentially, and there are additional restrictions about
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	708 the data access operations you can do inside the loop body.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	709
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	710 @strong{Warning:} parallel processing pools are currently unimplemented in
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	711 Octave; @code{parfor} currently behaves exactly as a normal @code{for} loop.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	712
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	713 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	714 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	715 parfor i = 1:10
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	716 i
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	717 endparfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	718 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	719 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	720 @seealso{for, do, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	721 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	722 persistent
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	723 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	724 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	725 @deftypefn {} {} persistent @var{var}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	726 Declare variables as persistent.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	727
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	728 A variable that has been declared persistent within a function will retain its
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	729 contents in memory between subsequent calls to the same function. The
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	730 difference between persistent variables and global variables is that persistent
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	731 variables are local in scope to a particular function and are not visible
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	732 elsewhere.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	733 @seealso{global}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	734 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	735 return
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	736 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	737 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	738 @deftypefn {} {} return
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	739 Return from a function.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	740 @seealso{function}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	741 @end deftypefn
28517 6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	742 spmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	743 @c libinterp/parse-tree/oct-parse.yy
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	744 -- texinfo --
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	745 @deftypefn {} {} spmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	746 @deftypefnx {} {} spmd (@var{n})
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	747 @deftypefnx {} {} spmd (@var{m}, @var{n})
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	748 Begin a block of statements which may execute in parallel across multiple
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	749 workers.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	750
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	751 If Octave has a parallel processing pool enabled, the block of code will be
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	752 executed in parallel across all of the pool's workers. Otherwise, @code{spmd}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	753 has no effect and the statements are processed as normal code by the main
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	754 Octave interpreter.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	755
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	756 If called with one additional argument @var{n} then use exactly @var{n} workers
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	757 from the pool. If called with two arguments @var{m}, @var{n} then use a
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	758 minimum of @var{m} workers and a maximum of @var{n} workers from the parallel
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	759 pool.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	760
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	761 @strong{Warning:} parallel processing pools are currently unimplemented in
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	762 Octave; @code{spmd} currently does nothing, but is included to avoid breaking
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	763 existing @sc{matlab} code.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	764
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	765 @seealso{parfor}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	766 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	767 switch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	768 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	769 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	770 @deftypefn {} {} switch @var{statement}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	771 Begin a switch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	772
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	773 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	774 @group
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	775 yesno = "yes";
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	776
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	777 switch (yesno)
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	778 case @{"Yes" "yes" "YES" "y" "Y"@}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	779 value = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	780 case @{"No" "no" "NO" "n" "N"@}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	781 value = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	782 otherwise
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	783 error ("invalid value");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	784 endswitch
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	785 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	786 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	787 @seealso{if, case, otherwise}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	788 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	789 try
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	790 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	791 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	792 @deftypefn {} {} try
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	793 Begin a try-catch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	794
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	795 If an error occurs within a try block, then the catch code will be run and
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	796 execution will proceed after the catch block (though it is often recommended to
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	797 use the lasterr function to re-throw the error after cleanup is completed).
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	798 @seealso{catch, unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	799 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	800 until
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	801 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	802 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	803 @deftypefn {} {} until (@var{cond})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	804 End a do-until loop. See @code{do} for an example.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	805 @seealso{do}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	806 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	807 unwind_protect
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	808 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	809 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	810 @deftypefn {} {} unwind_protect
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	811 Begin an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	812
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	813 If an error occurs within the first part of an unwind_protect block the
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	814 commands within the unwind_protect_cleanup block are executed before the error
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	815 is thrown. If an error is not thrown, then the unwind_protect_cleanup block is
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	816 still executed. In other words, the unwind_protect_cleanup code is guaranteed
24691 b658e0fa0cb3 maint: Remove trailing whitespace from files. Rik <rik@octave.org> parents: 24534 diff changeset	817 to execute regardless of success or failure in the unwind_protect block.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	818 @seealso{unwind_protect_cleanup, try}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	819 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	820 unwind_protect_cleanup
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	821 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	822 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	823 @deftypefn {} {} unwind_protect_cleanup
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	824 Begin the cleanup section of an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	825 @seealso{unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	826 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	827 varargin
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	828 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	829 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	830 @deftypefn {} {} varargin
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	831 Pass an arbitrary number of arguments into a function.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	832 @seealso{varargout, nargin, isargout, nargout, nthargout}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	833 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	834 varargout
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	835 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	836 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	837 @deftypefn {} {} varargout
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	838 Pass an arbitrary number of arguments out of a function.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	839 @seealso{varargin, nargin, isargout, nargout, nthargout}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	840 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	841 while
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	842 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	843 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	844 @deftypefn {} {} while
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	845 Begin a while loop.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	846
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	847 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	848 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	849 i = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	850 while (i < 10)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	851 i++
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	852 endwhile
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	853 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	854 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	855 @seealso{do, endwhile, for, until}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	856 @end deftypefn

Mercurial > octave

annotate libinterp/op-kw-docs @ 28517:6e8a9845d118