Add performance notes to steepest descent stuff.

[octave.git] / optimization / steepest_descent.m

diff --git a/optimization/steepest_descent.m b/optimization/steepest_descent.m
index 32aad711457ec2d04aa5d0985cd4286769bb79cc..c5bf0bca611d2d83747568ecbbc9c67506684650 100644 (file)
--- a/optimization/steepest_descent.m
+++ b/optimization/steepest_descent.m
@@ -35,6 +35,12 @@ function [x, k] = steepest_descent(g, x0, step_size, tolerance, max_iterations)
   %
   %   * ``k`` - the value of k when we stop; i.e. the number of
   %   iterations.
+  %
+  % NOTES:
+  %
+  % A specialized implementation for solving e.g. Qx=b can avoid one
+  % matrix-vector multiplication below.
+  %
 
   % The initial gradient at x_{0} is not supplied, so we compute it
   % here and begin the loop at k=1.