Mercurial > octave
changeset 31270:635ef1eb7dc3 stable
doc: Improve docstring readability for pqpnonneg.m
pqpnonneg.m: Single quotes were being used to present an expression with
multiple transpose operators, causing confusion. This patch adds parentheses
and spaces for readability.
| author | Arun Giridhar <arungiridhar@gmail.com> |
|---|---|
| date | Fri, 07 Oct 2022 06:54:49 -0400 |
| parents | 44a68ac1a22f |
| children | 6cf7dab21e9b 9a7bc1a2b20b |
| files | scripts/optimization/pqpnonneg.m |
| diffstat | 1 files changed, 2 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/optimization/pqpnonneg.m Fri Oct 07 06:14:40 2022 -0400 +++ b/scripts/optimization/pqpnonneg.m Fri Oct 07 06:54:49 2022 -0400 @@ -32,8 +32,8 @@ ## @deftypefnx {} {[@var{x}, @var{minval}, @var{exitflag}, @var{output}] =} pqpnonneg (@dots{}) ## @deftypefnx {} {[@var{x}, @var{minval}, @var{exitflag}, @var{output}, @var{lambda}] =} pqpnonneg (@dots{}) ## -## Minimize @code{1/2*@var{x}'*@var{c}*@var{x} + @var{d}'*@var{x}} subject to -## @code{@var{x} >= 0}. +## Minimize @code{ (1/2 * @var{x}' * @var{c} * @var{x} + @var{d}' * @var{x}) } +## subject to @code{@var{x} >= 0}. ## ## @var{c} and @var{d} must be real matrices, and @var{c} must be symmetric and ## positive definite.