changeset 29825:290eff7148bb stable

mrdivide, mldivide: Document that functions might return minimum norm solutions (bug #60839). * libinterp/corefcn/data.cc (Fmrdivide, Fmldivide): Document that functions might return minimum norm solutions.
author Markus Mützel <markus.muetzel@gmx.de>
date Mon, 28 Jun 2021 10:30:11 +0200
parents 6e42c37fbc8a
children a48151f59b69 6d1224698acf
files libinterp/corefcn/data.cc
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc	Mon Jun 28 10:03:20 2021 +0200
+++ b/libinterp/corefcn/data.cc	Mon Jun 28 10:30:11 2021 +0200
@@ -6148,6 +6148,9 @@
 Return the matrix right division of @var{x} and @var{y}.
 
 This function and @w{@tcode{@var{x} / @var{y}}} are equivalent.
+
+If the system is not square, or if the coefficient matrix is singular, a
+minimum norm solution is computed.
 @seealso{mldivide, rdivide, plus, minus}
 @end deftypefn */)
 {
@@ -6172,7 +6175,10 @@
 Return the matrix left division of @var{x} and @var{y}.
 
 This function and @w{@tcode{@var{x} @xbackslashchar{} @var{y}}} are equivalent.
-@seealso{mrdivide, ldivide, rdivide}
+
+If the system is not square, or if the coefficient matrix is singular, a
+minimum norm solution is computed.
+@seealso{mrdivide, ldivide, rdivide, linsolve}
 @end deftypefn */)
 {
   return binary_op_defun_body (octave_value::op_ldiv, args);