Storing functions in classdef files

Question

Benjamin D'Anjou 2019-5-28

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/464356-storing-functions-in-classdef-files

评论： Steven Lord 2019-5-28

I have an object-oriented Matlab project with several classes. I store each class definition in a @-folder within a folder pathFolder (in Windows). For instance

pathFolder\@myClass\myClass.m

In the constructor of each class, I use custom-defined functions. For instance, here I would use myFunction to initialize a complicated property:

classdef myClass
    properties
        x;
        y;
        complicatedProperty;
    end
    
    methods
        function obj = myClass(x,y)
        obj.x = x;
        obj.y = y;
        obj.complicatedProperty = myFunction(x,y);
        end
    end
end

Right now myFunction is located in pathFolder along with the @-folder

pathFolder\@myClass\myClass.m
pathFolder\myFunction.m

That works. However, I only use myFunction within the constructor of myClass. To better organize my files, I would very much like to group myFunction.m with the class definition. However, I can't put it in the @-folder because .m files contained in the @-folder are not in the path and are automatically treated as methods of the class.

One option is to define myFunction as a static method of myClass, but I want to avoid that (it causes problems when I try to call superclass constructors in subclasses).

Another alternative is to define myFunction as a local function in myClass.m but I would also like to avoid that. I want to keep it in a separate file.

Is there a way to put the separate file myFunction.m in the @-folder so that it will be recognized in the Matlab path? I welcome suggestions.

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

请先登录，再进行评论。

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

Answer 1

Guillaume 2019-5-28

2
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/464356-storing-functions-in-classdef-files#answer_376941

Private functions are ideal for this. Store the functions in a folder called private inside the @ folder. Any function inside the private folder is only visible to m files in the containing folder, without needing to be added to the path.

1 个评论
显示 -1更早的评论隐藏 -1更早的评论

Benjamin D'Anjou 2019-5-28

Works like a charm, thank you.

请先登录，再进行评论。

Answer 2

Benjamin D'Anjou 2019-5-28

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/464356-storing-functions-in-classdef-files#answer_376938

在 MATLAB Online 中打开

In the end I decided to store both myFunction.m and the @-folder in another path folder that has the same name as the class:

pathFolder\myClass\@myClass\myClass.m
pathFolder\myClass\myFunction.m

Not exactly what I wanted, but it works well enough.

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

请先登录，再进行评论。

Answer 3

Steven Lord 2019-5-28

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/464356-storing-functions-in-classdef-files#answer_376945

Another alternative is to define myFunction as a local function in myClass.m but I would also like to avoid that. I want to keep it in a separate file.

Why do you want to avoid this? If only one class uses this function, why not make it local to the class? I would likely write this as a class-related function at the end of the classdef file, after the end that closes the classdef block.

2 个评论
显示无隐藏无

Benjamin D'Anjou 2019-5-28

编辑：Benjamin D'Anjou 2019-5-28

Because it is easier for me to find my way in my code that way. That simple. It is incredibly painful to me to scroll down a long classdef file when I want to modify one of these local functions. I'd rather navigate folders.

Steven Lord 2019-5-28

There are tools that can help you navigate around your file. The "Go To Location in File" section of this documentation page lists many of these. I use bookmarks (set a bookmark in your current location and the helper, jump to the next bookmark to modify the class-related function, jump to the "next" bookmark which will wrap around) and the context menu "Open Selection" option to navigate around long class files quite a bit.

请先登录，再进行评论。