view scripts/miscellaneous/clearAllMemoizedCaches.m @ 31247:3dae836c598c

doc: Expand and edit documentation for memoization (bug #60860)
author Arun Giridhar <arungiridhar@gmail.com>
date Fri, 30 Sep 2022 06:38:59 -0400
parents a887ffb997a7
children a40c0b7aa376
line wrap: on
line source

########################################################################
##
## Copyright (C) 2021 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn  {} {} clearAllMemoizedCaches ()
## Clear all memoized caches.
##
## Memoization maintains internal tables of which functions have been called
## with which inputs.  This function clears those tables to free memory,
## or for a fresh start.
##
## @seealso{memoize}
## @end deftypefn

function clearAllMemoizedCaches

   if (nargin || nargout)
    print_usage ();
  endif

  __memoize__ ();

endfunction

## Mark file as being tested.  No real test needed for this function.
%!assert (1)