Add listener programmatically for each object method

Question

Thomas Ewald 2024-4-30

2
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2113351-add-listener-programmatically-for-each-object-method

评论： Thomas Ewald 2024-5-3

采纳的回答： Matt J

在 MATLAB Online 中打开

Hello there!

I have the following situation: Let's say I have a class:

classdef Memoizer < handle & matlab.mixin.Heterogeneous
    methods
        function obj = Memoizer()
            ... constructor code
        end
        function val = veryExpensiveMethod(obj, argsAsObj)
            ... some very time consuming code
        end
        function val = calledByListener(obj, methodName, argsAsObj)
            ... some code to check if method was called before and there are results cached
            fcn_handle = str2func(methodName);
            val = fcn_handle(argsAsObj);
        end
    end
end

Is it possible to add a listener to the specific method veryExpensiveMethod, where the listener will have access to the input argument argsAsObj of the method and is called automatically, without using notify()? The callback should be calledByListener. Essentially, the idea would be, that I can implement the method veryExpensiveMethod without thinking about firing events, but each call to the method will automatically fire such an event, and consequently call calledByListener.

I saw that you can add listeners to object properties (preGet, postGet, preSet, postSet) - which is essentially what I need, but I need it for a method call - e.g., preCalled.

In the example it is important that the class inherits from Heterogeneous. This is crucial, thus I cannot use RedefineDot operations in order to trigger events, which is not compatible with Heterogeneous. Anyways, dumping the Heterogeneous from the class definition would not solve the problem entirely, since RedefineDot is only triggered when object methods are called publicly (from the outside), but not if one method calls another method inside the object. In addition, RedefineDot does not have access to the method call's input arguments.

So, is it possible to have automatic/programmatic listener creation based on a method name, that creates a preCalled listener for a method? I can use the call stack, if that helps.

EDIT:

I forgot to add the object's reference as first input to all the methods. This, unfortunately, changes the requirements. The input argument argsAsObj is supposed to reflect the fact, that veryExpensiveMethod can be considered as a method whos entirety of input values can be passed as an object.

Best regards and thanks a lot in advance!

TE

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

Steven Lord 2024-5-1

在 MATLAB Online 中打开

My initial thought was that I can create a <hidden> mechanic in a class file, that automatically caches results of any class method that is called.

No, there is no such attribute.

veryExpensiveMethod would in fact be a method of a class that would inherit from Memoizer, so that the listener, and the mechnic, would be part of that child class.

No. memoize is a function that accepts a function handle and returns an object that can be used to cache inputs to and outputs from that function handle. Here's an example of its use:

M = memoize(@expensiveFunction);
tic; M(5), toc % Call the function, takes a long time due to the pause() call
ans = 25
Elapsed time is 2.022727 seconds.
tic; M(6), toc % Call the function, takes a long time due to the pause() call
ans = 36
Elapsed time is 2.004542 seconds.
tic; M(5), toc % Use cached results -- much quicker, no pause()
ans = 25
Elapsed time is 0.003743 seconds.

If we clear the cache, M(5) goes back to calling the function (with its pause call, to simulate an expensive computation) again.

clearCache(M);
tic; M(5), toc % No result for M(5) in the cache, calls pause()
ans = 25
Elapsed time is 2.004922 seconds.

You could use this by creating M in the constructor using a handle to the "payload" function (whatever actually performs the computations that take a long time) and storing it in a property of your object. Your expensive function would then call its payload function via this property rather than calling it directly.

function y = expensiveFunction(x)
y = x.^2;
pause(2)
end

Thomas Ewald 2024-5-2

@Steven Lord Thanks again for the reply!

Currently, Memiozer class would be the superclass for actual classes implementing these expensive payload methods. Therefore, the Memoizer does not know a priori which methods there will be. I was thinking about using Matlab's memoize for my purposes already, but this would mean, that I have to deal with dynamic properties, which are created for each method that the child class implements. I would like to avoid that.

Instead I will try to have a central storage (e.g., a dictionary), that stores a number of Matlab's memoize classes corresponding to the method's name. A small method in Memoizer class would take care of the routing. Then, only one line of code would change inside and outside the object, depending on it you want to cache results or not.

A last question regarding this, which botheres me, is: How does Matlab's memoize deal with objects as inputs to the method. Specifically, how is equality determined, and can I rely on it identifying identical data inside objects also on nested objects? I don't need the handle to be identical (==), but the content. My guess is, that memoize calls isequal, is that correct?

Steven Lord 2024-5-2

From this statement on the documentation page, I believe it will call isequaln to determine if the inputs are the same as a cached set of inputs but I'm not 100% certain.

"The input arguments are numerically equal to cached inputs. When comparing input values, MATLAB treats NaNs as equal."

I recommend contacting Technical Support to ask this question (and asking that they file an enhancement request for the documentation to describe how determining when to use the cache is handled when one of the inputs is an object.)

Thomas Ewald 2024-5-2

Thanks for the comment, I will do that.

请先登录，再进行评论。

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

Answer 1

Matt J 2024-5-2

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2113351-add-listener-programmatically-for-each-object-method#answer_1451481

在 MATLAB Online 中打开

myclass.m

In the project I am working on, many people contribute, and all would have to remember and implement this line.

It wouldn't be so hard for the project leader to write a code-modifying tool that inserts the notify() commands automatically, e.g.,

S=readlines('myclass.m')
S = 16x1 string array
    "classdef  myclass"
    ""
    "   properties"
    "        a"
    "   end"
    "    "
    "   methods "
    "       function func1(obj,argsObj)"
    ""
    "       end"
    "       function func2(obj,argsObj)"
    ""
    "       end"
    ""
    "   end"
    "end"
for i=1:numel(S)
    
    if startsWith(S(i),whitespacePattern+"function")
        S(i)=S(i)+";  notify(stuff);";
    end
    
end
S
S = 16x1 string array
    "classdef  myclass"
    ""
    "   properties"
    "        a"
    "   end"
    "    "
    "   methods "
    "       function func1(obj,argsObj);  notify(stuff);"
    ""
    "       end"
    "       function func2(obj,argsObj);  notify(stuff);"
    ""
    "       end"
    ""
    "   end"
    "end"