clear persistent variables in sub-functions

Question

J. Smith 2015-9-9

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/241417-clear-persistent-variables-in-sub-functions

评论： Stephen23 2017-4-14

Hi,

I have a script that calls a function, which is written in separate file and contains sub-functions that are inner to main function only. In one of my sub-functions, I have persistent variable that I would like to clear every time I run the main script. How can I do so? In addition, I have breakpoints through my code, and I would prefer to keep them while I clear the persistent variable - how that can be done?

MainScript.m script:

clear variables;
y = MyMainFunction();

MyMainFunction code:

function temp = MyMainFunction()
  some code...
  temp = MySubFunction(var);
  some code...
end
function dataOut = MySubFunction(dataIn)
  persistent idx;
  some code...
end

I would like to clear "idx" persistent variable every time that I run MainScript.m, but of course to keep that variable as long as the script is running.

Thanks, John

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

Stephen23 2015-9-9

1
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/241417-clear-persistent-variables-in-sub-functions#answer_191749

编辑：Stephen23 2015-9-9

在 MATLAB Online 中打开

The simplest method would be to clear the subfunction:

function temp = MyMainFunction()
  clear('MySubFunction')
  some code...
  temp = MySubFunction(var);
  some code...
end

Another simple method would be to introduce an special case, such as using nargin:

clear variables;
y = MyMainFunction();
function temp = MyMainFunction()
  MySubFunction;
  some code...
  temp = MySubFunction(var);
  some code...
end
function dataOut = MySubFunction(dataIn)
  persistent idx;
  if nargin==0
     clear whatever variables here...
     return
  end
  some code...
end

6 个评论
显示 4更早的评论隐藏 4更早的评论

J. Smith 2015-9-9

Hi Walter,

I did something like you said (with iterNum instead of clearsubs), and check that only in the first time I call MyMainFunction, I then call "clear MySubFunction", but strangely that doesn't always works.

To be specific, MyMainFunction is in a for loop for 5 iterations, and when iterNum==1, I call the clear subfunction command. When I open MATLAB and run the script for the first time, than if I put a breakpoint after the line where I declare the persistent variable, I see that this variable is empty as it should be. After that, I continue the run, and it finishes after 5 iterations of MyMainFunction calls. When I run the script for the second time, then in the first iteration MyMainFunction is called, I call the "clear MySubFunction" (using if statement, while I make sure that this statement is actually happens using breakpoint at the "clear MySubFunction" command), and when I actually enters MySubFunction and see that value of my persistent variable (after its declaration), I see that the "idx" persistent variable, is set to "6" instead of "empty", which indicates that it was never cleared, as it should had.

What can be the reason that the "clear MySubFunction" command is not working properly? If my explanation was a little bit confusing, I'll add the relevant code (I don't have it on me right now).

Thanks, John

Stephen23 2015-9-9

编辑：Stephen23 2015-9-9

在 MATLAB Online 中打开

@J.Smith: this is easy, just move the "reset call" to the script, instead of inside the main function as I wrote in my answer:

clear variables;
MySubFunction;
y = MyMainFunction();
function temp = MyMainFunction()
  some code...
  temp = MySubFunction(var);
  some code...
end

Or better:

clear variables;
clear('MySubFunction')
y = MyMainFunction();

J. Smith 2015-9-10

As I mentioned earlier, this cannot be done as the sub-function is not known at the script, but only the main-function.

请先登录，再进行评论。

Answer 2

Philip Borghesani 2015-9-9

1
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/241417-clear-persistent-variables-in-sub-functions#answer_191810

在 MATLAB Online 中打开

I would not use a perstent variable for this. Use a nested function and local variable

function temp = MyMainFunction()
  some code...
  myCommonVar=[]; %or any useful initial value
  temp = MySubFunction(var);
  some code...
  function dataOut = MySubFunction(dataIn)
    %use myCommonVar just as if it were persistent
    %it will last as long as the call to MyMainFunction;
    some code...
  end
end

As to clearing the local function or function: in general James's analysis is correct. He missed on key point that may not be well documented. Only top level or main functions (with the same name as the file) may be cleared. To clear any local or nested function the main function must be cleared and that can't be done while the main function (or any other function in the file) is running.

2 个评论
显示无隐藏无

J. Smith 2015-9-10

@Philip:

I prefer using local\sub function instead of nested function as the first one is more elegant use of code splitting to small tasks, as it's done in all other programming languages.

Furthermore, regarding your suggestion, myCommonVar will be reset every time I enter MyMainFunction and this is not what I want. I want to enter MyMainFunction for 5 times\iterations, and then when I run the MainScript.m again, it will start with a blank value.

About your last comment, if I understood you correctly, the reason that "clear MySubFunction" command is not working for me, is because it's called from MyMainFunction file that contains MySubFunction? So what is the workaround for this issue?

Philip Borghesani 2015-9-10

Only whole m files can be cleared from memory. The entire file is managed as a unit so sub functions can't be cleared without clearing the main function. It seems like clearing MyManFunction from MainScript as suggested previously is the correct solution. Why does this not work for you?

请先登录，再进行评论。

Answer 3

James Tursa 2015-9-9

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/241417-clear-persistent-variables-in-sub-functions#answer_191745

编辑：James Tursa 2015-9-9

What happens if you clear MyMainFunction? (Or clear functions)

14 个评论
显示 12更早的评论隐藏 12更早的评论

James Tursa 2015-9-9

编辑：James Tursa 2015-9-9

I have done some limited testing (R2013a Win64) and here is what I have observed:

I started with a file function_name.m and at the end of that file there is a sub function called subfunction. function_name calls subfunction. Inside subfunction is a persistent variable called p.

clear all, clear functions, and clear function_name all clear the function and the persistent variable p inside the subfunction, just as I expected from my interpretation of the doc table noted above.

However, there is a gotcha I have discovered. When any of these clear commands is issued from within the function_name function itself, the command apparently gets queued and doesn't take effect until after function_name exits. Mind you, I don't know if this is really an accurate description of what is really happening, but that is the behavior I am seeing.

To be clear, function_name.m is a function file that calls subfunction which is a function at the end of the function_name.m file. subfunction has a persistent variable p. Upon entry to subfunction, a message prints to state if p is currently empty or not. If p is empty then p is created as a large 200MB variable (so that its presence easily show up in the memory command).

When I issue clear all, clear functions, or clear function_name from either the command line or from another function file, p gets cleared from memory every time (i.e., the subsequent calling of function_name (and thus subfunction) gives a message that p is empty and needs to be created). But when I issue any of these clear commands from within function_name, and then immediately call subfunction, subfunction gives a message that p already exists and indeed the 200MB memory for it shows up when memory is examined from within subfunction. But once subfunction returns to function_name, and function_name returns to the command line, a memory command reveals that p is no longer there (the 200MB has been free'd). I.e., it is as if the clear command got queued and didn't execute until after the functions exited (which I guess makes sense ... how could the currently executing function get cleared from memory immediately while it is executing?).

Stephen23 2017-4-14

编辑：Stephen23 2017-4-14

MATLAB is definitely Turing complete, so there is no computational problem that MATLAB cannot do. This is not a question what can or cannot be done, and to look at it from that perspective is not going to help you. Trying to write code in one language as if were another language is the problem. When converting a function from one language to another there are always going to be different ways of doing things, and in many cases efficiency (implementation time, bug-fixing time, running time) will dictate that changes need to occur.

"matlab can't do that, so rewrite your code"

MATLAB can achieve your task, but not if you try and approach writing MATLAB code as if it were FORTRAN code. Would you try to write C++ code as if it were Python? Would you expect it to be efficient? Do you write your Haskell as if it were Perl? (I shudder to think how awful that would be). Even if MATLAB has evolved from FORTRAN, there is no reason why any language idioms have to be the same.

Jan Simon is correct: to make this work in MATLAB you need to design MATLAB code from the ground up.

Or, if the exact behavior is important, why not simply call the FORTRAN from MATLAB?

Ben Barrowes 2017-4-14

I agree rewriting a code with excellent skills would be a worthwhile goal. The difficulty is that many of my clients don't have the resources to make that goal from the beginning.

Many times, companies come to me with anything from old crufty fortran IV or f77 code to modern code that they need converted source to source into matlab, but they don't have the time or money to do a complete rewrite. What they would like is a working conversion in matlab (for a tenth or hundredth of the time and money of a rewrite) of their 10kline to 1000kline+ code rapidly and cheaply. Then their plan is to switch to matlab for that code and modify and develop the matlab code gradually going forward. I can do that for them if I can get the matlab conversion to behave like the fortran version. If I have to modify 400klines of matlab code and 3000 variables to not depend on persistence, it can amount to a rewrite which my clients do not want though maybe in a perfect world they would.

This persistent variable issue is one issue that I would like a solution to in matlab. In addition, the documentation is essentially incorrect for "clear functions." I have a workaround by adding "clear all" at the end of the main program but I would like a way to clear all persistent variables at the entrance to a m-file. I am simply asking matlab to provide a feature that they currently claim they provide in their documentation.

Stephen23 2017-4-14

@Ben Barrows: it sounds like you have experience to build a robust explanation and case for either submitting a bug report (incorrect documentation), or requesting an enhancement. Make this formal and see what response you get from TMW.

请先登录，再进行评论。

clear persistent variables in sub-functions

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

回答（3 个）

6 个评论
显示 4更早的评论隐藏 4更早的评论

2 个评论
显示无隐藏无

14 个评论
显示 12更早的评论隐藏 12更早的评论

另请参阅

类别

标签

Community Treasure Hunt

clear persistent variables in sub-functions

0 个评论 显示 -2更早的评论隐藏 -2更早的评论

回答（3 个）

6 个评论 显示 4更早的评论隐藏 4更早的评论

2 个评论 显示 无隐藏 无

14 个评论 显示 12更早的评论隐藏 12更早的评论

另请参阅

类别

标签

Community Treasure Hunt

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

6 个评论
显示 4更早的评论隐藏 4更早的评论

2 个评论
显示无隐藏无

14 个评论
显示 12更早的评论隐藏 12更早的评论