Mercurial > octave

diff scripts/miscellaneous/memoize.m @ 31253:a40c0b7aa376

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: changes to follow Octave coding conventions. * NEWS.8.md: Wrap lines to 72 chars. * LSODE-opts.in: Use two spaces after sentence ending period. * LSODE.cc: Use minimum of two spaces between code and start of comment. * MemoizedFunction.m: Change copyright date to 2022 since this is the year it was accepted into core. Don't wrap error() lines to 80 chars. Use newlines to improve readability of switch statements. Use minimum of two spaces between code and start of comment. * del2.m, integral.m, interp1.m, interp2.m, griddata.m, inpolygon.m, waitbar.m, cubehelix.m, ind2x.m, importdata.m, textread.m, logm.m, lighting.m, shading.m, xticklabels.m, yticklabels.m, zticklabels.m, colorbar.m, meshc.m, print.m, __gnuplot_draw_axes__.m, struct2hdl.m, ppval.m, ismember.m, iqr.m: Use a space between comment character '#' and start of comment. Use hyphen for adjectives describing dimensions such as "1-D". * vectorize.m, ode23s.m: Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. * clearAllMemoizedCaches.m: Change copyright date to 2022 since this is the year it was accepted into core. Remove input validation which is done by interpreter. Use two newlines between end of code and start of BIST tests. * memoize.m: Change copyright date to 2022 since this is the year it was accepted into core. Re-wrap documentation to 80 chars. Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. Use two newlines between end of code and start of BIST tests. Use semicolon for assert statements within %!test block. Re-write BIST tests for input validation. * __memoize__.m: Change copyright date to 2022 since this is the year it was accepted into core. Use spaces in for statements to improve readability. * unique.m: Add FIXME note to commented BIST test * dec2bin.m: Remove stray newline at end of file. * triplequad.m: Reduce doubly-commented BIST syntax using "#%!#" to "#%!". * delaunayn.m: Use input variable names in error() statements. Use minimum of two spaces between code and start of comment. Use hyphen for describing dimensions. Use two newlines between end of code and start of BIST tests. Update BIST tests to pass.
author Rik <rik@octave.org>
date Mon, 03 Oct 2022 18:06:55 -0700
parents 3dae836c598c
children 96f751f8392c
line wrap: on
line diff
--- a/scripts/miscellaneous/memoize.m	Sun Oct 02 09:00:28 2022 -0400
+++ b/scripts/miscellaneous/memoize.m	Mon Oct 03 18:06:55 2022 -0700
@@ -1,6 +1,6 @@
 ########################################################################
 ##
-## Copyright (C) 2021 The Octave Project Developers
+## Copyright (C) 2022 The Octave Project Developers
 ##
 ## See the file COPYRIGHT.md in the top-level directory of this
 ## distribution or <https://octave.org/copyright/>.
@@ -26,8 +26,7 @@
 ## -*- texinfo -*-
 ## @deftypefn  {} {@var{mem_fcn_handle} =} memoize (@var{fcn_handle})
 ##
-## Create a memoized version @var{mem_fcn_handle} of function
-## @var{fcn_handle}.
+## Create a memoized version @var{mem_fcn_handle} of function @var{fcn_handle}.
 ##
 ## Each call to the memoized version @var{mem_fcn_handle} checks the inputs
 ## against an internally maintained table, and if the inputs have occurred
@@ -35,12 +34,12 @@
 ## itself instead of evaluating the full function again.  This speeds up the
 ## execution of functions that are called with the same inputs multiple times.
 ##
-## For example, here we take a slow user-written function named
-## @code{slow_fcn} and memoize it to a new handle @code{cyc}.
-## The first executions of both versions take the same time, but the subsequent
-## executions of the memoized version returns the previously computed value,
-## thus reducing 2.4 seconds of runtime to only 2.4 milliseconds.  The final
-## check verifies that the same result was returned from both versions.
+## For example, here we take a slow user-written function named @code{slow_fcn}
+## and memoize it to a new handle @code{cyc}.  The first executions of both
+## versions take the same time, but the subsequent executions of the memoized
+## version returns the previously computed value, thus reducing 2.4 seconds of
+## runtime to only 2.4 milliseconds.  The final check verifies that the same
+## result was returned from both versions.
 ##
 ## @example
 ## @group
@@ -65,10 +64,11 @@
 
 function mem_fcn_handle = memoize (fcn_handle)
 
-  if (nargin != 1 || nargout > 1)
+  if (nargin != 1)
     print_usage ();
   endif
-  if (! isa (fcn_handle, "function_handle"))
+
+  if (! is_function_handle (fcn_handle))
     error ("memoize: FCN_HANDLE must be a function handle");
   endif
 
@@ -76,13 +76,14 @@
 
 endfunction
 
+
 %!test
 %! fcn1 = memoize (@sin);
 %! assert (isa (fcn1, "matlab.lang.MemoizedFunction"));
 %! fcn1 (pi);
 %! fcn2 = memoize (@sin);
 %! fcn2 (2*pi);
-%! assert (isequal (fcn1, fcn2))
+%! assert (isequal (fcn1, fcn2));
 
 %!test
 %! fcn = memoize (@rand);
@@ -100,8 +101,6 @@
 %! clearCache (fcn);
 %! fcn.clearCache;
 
-# Test input validation
-%!error memoize ();
-%!error memoize (1, 2);
-%!error [a, b] = memoize (1);
-%!error memoize (1);
+## Test input validation
+%!error <Invalid call> memoize ();
+%!error <FCN_HANDLE must be a function handle> memoize (1);