Mercurial > octave

annotate scripts/help/slash.m @ 31191:bb9d776eafac stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix wrong color in PDF printout of some latex strings (bug #62884) * octave-svgconvert (draw): For "rect" elements only set brush color if necessary and eventually restore to previous color.
author Pantxo Diribarne <pantxo.diribarne@gmail.com>
date Sun, 14 Aug 2022 18:24:07 +0200
parents 796f54d4ddbf
children 597f3ee61a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ##
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
3 ## Copyright (C) 2017-2022 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
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/>.
23045
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
7 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
8 ## This file is part of Octave.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23086
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
23045
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.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: 23086
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
23045
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
13 ## (at your option) any later version.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
14 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
18 ## GNU General Public License for more details.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
19 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.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: 23086
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 ########################################################################
23045
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
25
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
26 ## -*- texinfo -*-
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
27 ## @documentencoding UTF-8
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
28 ## @defvr {Documentation} slash
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
29 ## Backslash and slash perform various sorts of division.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
30 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
31 ## @table @asis
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
32 ## @item @code{\} Matrix Left Division (``backslash'')
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
33 ## Solve systems of equations
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
34 ## @iftex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
35 ## $Ax = b$ for $x$.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
36 ## @end iftex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
37 ## @ifnottex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
38 ## Ax = b for x.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
39 ## @end ifnottex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
40 ## @code{A \ b} is conceptually equivalent to @code{inv (A) * b} but is
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
41 ## computed more efficiently and accurately, without forming the matrix
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
42 ## inverse directly.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
43 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
44 ## Example:
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
45 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
46 ## @example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
47 ## @group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
48 ## A = [1 2; 3 4];
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
49 ## b = [4; 2];
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
50 ## x = A \ b
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
51 ## @result{} x =
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
52 ## -6
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
53 ## 5
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
54 ## isequal (A*x, b)
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
55 ## @result{} 1
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
56 ## @end group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
57 ## @end example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
58 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
59 ## If the system is not square, or if the matrix is singular, a minimum-norm
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
60 ## solution is computed (@code{norm (A*x - b)}).
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
61 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
62 ## For dense matrices, backslash uses the Gaussian Elimination algorithm
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
63 ## with partial pivoting. For sparse matrices, backslash uses a direct
28959
5394d688d456 doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
Rik <rik@octave.org>
parents: 27923
diff changeset
64 ## method to compute an LU factorization (@pxref{XREFlu,,@code{lu}}). The
5394d688d456 doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
Rik <rik@octave.org>
parents: 27923
diff changeset
65 ## direct method tries to minimize ``fill-in'' of zeros but it could
5394d688d456 doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
Rik <rik@octave.org>
parents: 27923
diff changeset
66 ## nonetheless use a lot of memory; if this is a concern, consider an iterative
5394d688d456 doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
Rik <rik@octave.org>
parents: 27923
diff changeset
67 ## method (@pxref{XREFcgs,,@code{cgs}} or @pxref{XREFgmres,,@code{gmres}}).
23045
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
68 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
69 ## @item @code{/} Matrix Right Division
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
70 ## The forward slash notation can be used to solve systems of the form
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
71 ## @iftex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
72 ## $AB = C$ for $A$
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
73 ## @end iftex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
74 ## @ifnottex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
75 ## AB = C for A
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
76 ## @end ifnottex
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
77 ## using @code{A = C / B}.
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
78 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
79 ## @item @code{./} and @code{.\} Component-wise ``Hadamard'' Division
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
80 ## The ``dot slash'' operators perform element-by-element division, for
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
81 ## example:
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
82 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
83 ## @example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
84 ## @group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
85 ## A = [1 10 12; 24 30 42];
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
86 ## B = [1 5 4; 6 6 7];
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
87 ## A ./ B
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
88 ## @result{}
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
89 ## 1 2 3
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
90 ## 4 5 6
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
91 ## @end group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
92 ## @end example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
93 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
94 ## If the sizes are not the same, ``broadcasting'' may apply
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
95 ## (@pxref{Broadcasting}):
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
96 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
97 ## @example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
98 ## @group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
99 ## 420 ./ B
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
100 ## @result{}
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
101 ## 420 84 105
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
102 ## 70 70 60
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
103 ## [20; 42] ./ B
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
104 ## @result{}
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
105 ## 20 4 5
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
106 ## 7 7 6
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
107 ## @end group
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
108 ## @end example
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
109 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
110 ## @end table
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
111 ##
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
112 ## @seealso{mldivide, mrdivide, ldivide, rdivide, linsolve}
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
113 ## @end defvr
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
114
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
115
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
116 ## Mark file as being tested. No real test needed for a documentation .m file
29c346ee7abe doc: Add "help slash" documentation (bug #49526).
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
117 %!assert (1)