Classdef: Difference between revisions

From Octave
Jump to navigation Jump to search
 
(60 intermediate revisions by 11 users not shown)
Line 1: Line 1:
This page is a stub. We should begin documenting what classdef is implemented and what is not.
=== Supported Features ===


==== not supported ====
==== Properties ====


* debugging in classdef methods (and +package directory functions)
Classdef properties are supported but not all attributes are implemented.


Breakpoints cannot currently be set in classdef methods (or at least they are ignored). They also can't be set in functions in +package directories (which is a related issue).
{| class="wikitable"
|-
! style="text-align:left;"| Attribute
! Support
! Notes
|-
|AbortSet
|No
|Property does not exist.
|-
|Abstract
|Yes
|
|-
|Access
|Partial
|
|-
|Constant
|Yes
|
|-
|Dependent
|Partial
|
|-
|GetAccess
|Partial
|
|-
|GetObservable
|No
|Property exists but is not used.  Requires events and listeners to be implemented in order to work properly.
|-
|Hidden
|Yes
|
|-
|NonCopyable
|No
|Property does not exist.
|-
|SetAccess
|Partial
|
|-
|SetObservable
|No
|Property exists but is not used. Requires events and listeners to be implemented in order to work properly.
|-
|Transient
|No
|Property exists but is not used.
|}


* enumeration
==== Methods ====


* build-in class as superclass
Classdef methods are supported but not all attributes are fully implemented.
<source lang="octave">
classdef nonsense < uint32


end
{| class="wikitable"
</source>
|-
! style="text-align:left;"| Attribute
! Support
! Notes
|-
|Abstract
|Partial
|See bug report {{bug|51377}}
|-
|Access
|Yes
|
|-
|Hidden
|Yes
|
|-
|Sealed
|Yes
|
|-
|Static
|Yes
|
|}


* [http://www.mathworks.com/help/matlab/matlab_oop/redefining-concatenation-for-your-class.html concatenating objects] into [http://www.mathworks.com/help/matlab/matlab_oop/initialize-object-arrays.html array of objects]. Example:
=== Features that are not implemented ===
<source lang="octave">
classdef MyClass < handle
end


c = MyClass();
==== [https://www.mathworks.com/help/matlab/enumeration-classes.html enumeration] ====
cc = [c, c];  % won't work
</source>


For now you can use a cell-array of objects instead:
* {{bug|44582}} Parse the enumeration section of a classdef definition but nothing is done with it.
<source lang="octave">
cc = {c, c};  % ok
</source>


* [http://www.mathworks.com/help/matlab/matlab_oop/mutable-and-immutable-properties.html Immutable property] set access. Example:
==== [https://www.mathworks.com/help/matlab/matlab_oop/learning-to-use-events-and-listeners.html events and listeners] ====
<source lang="octave">
classdef MyClass < handle
    properties (SetAccess = immutable)
        x
    end
    methods
        function obj = MyClass()
            x = rand();
        end
    end
end
</source>


Use "private" properties as workaround.
* {{bug|56194}} Parse the events section of a classdef definition but nothing is done with it.


* Function handles to package methods and static class methods.
==== [https://www.mathworks.com/help/matlab/matlab_oop/property-validator-functions.html Property Validation Functions] ====
For example if we have <code>+mypackage/myfunc.m</code>, creating a function handle as <code>fh = @mypackage.myfunc</code> won't work.
As a workaround, we can create an indirection using an anonymous function <code>fh = @(varargin) mypackage.myfunc(varargin{:})</code>.
Similarly for static class methods where <code>fh = @MyClass.myfunc</code> isn't yet supported.  


A fuller example is also given below:
=== Open Bug Reports for Other Issues ===
<source lang="octave">
classdef method_function_handle_test


%  properties
==== Issues with basic classdef functionality ====
% 
% 
%  end
 
  properties (Hidden, SetAccess = protected)
    hfoo = [];% handle to function
  end
 
  methods
 
    function self = method_function_handle_test ()
      self.hfoo = @foo;   
    end
   
    function bar (self)
        self.hfoo (self);
    end


  end
* {{bug|51659}} Calling 'methods' on self causes syntax error
 
* {{bug|52096}} meta.class.fromName throws error when class name not found.
  methods (Hidden, Access = protected)
* {{bug|55983}} 'x(ix) = []' deletion syntax does not work for objects
    function foo (self)
* {{bug|55976}} cat, repmat, and reshape don't work for classdef objects
      disp ('hello!');
* {{bug|55961}} properties function does not preserve order - <em>Patch submitted, awaiting review</em>
    end
* {{bug|52582}} using static method to initialize property value fails
  end
* {{bug|45833}} support load/save of classdef objects
* {{bug|61676}} Assigning classdef objects to other types does not call converter methods
* {{bug|60729}} print_usage within classdef constructor breaks subsequent calls to the class


end
==== Classdef and +package directories ====
</source>
Then running:
<source lang="text">
>> x = method_function_handle_test
error: @foo: no function and no method found
error: called from
    method_function_handle_test at line 17 column 17
stopped in <****>/scratch/mfiles/octave_tests/method_function_handle_test.m at line 17
17:      self.hfoo = @foo;
</source>


* [https://savannah.gnu.org/bugs/?54941 54941] interpreter cannot find methods in files of classdefs in packages


* Defining [http://www.mathworks.com/help/matlab/matlab_oop/specifying-methods-and-functions.html#br2la89 local functions] in the same classdef-file is not working. For example, the following code gives a syntax/parse error:
==== Arrays of classdef objects ====
<source lang="octave">
classdef MyClass
    methods
        function obj = MyClass()
            myfunc()
        end
    end
end


function myfunc()
* {{bug|44665}} error in concatenation of classdef objects
    disp('myfunc')
* {{bug|53906}} Cannot make an object array with square brackets
end
* {{bug|47755}} Access to object arrays
</source>
* {{bug|47241}} classdef: assigning property of handle object in object array constructs new object


==== supported ====
==== Debugger (fixes for these are in progress) ====


* methods
* {{bug|46451}} <s>unable to set breakpoints within classdef classes</s> - <em> Patch closed </em>
** static
* {{bug|45404}} <s>Breakpoints cannot be set in classdef methods or +package function files</s> - <em>Report closed</em>
** private
* {{bug|65610}} unable to set breakpoints within set or get functions of classdef classes - <em> Patch applied, ready for test </em>


* properties
==== Lower-priority issues ====
** SetAccess (public/private/protected)


==== Classdef examples in the wild ====
* {{bug|55488}} Invalid use of colon char as classdef function's argument when subsref is overwritten
* {{bug|54966}} Error when assigning array to an object implementing subsasgn() subscripted using "{}"
* {{bug|54028}} copy of non-handle class instance is not deep
* {{bug|53811}} cellfun does not find overloaded function with function name argument
* {{bug|52989}} classdef: missing error messages on multiply defined properties
* {{bug|52582}} Dependent constant properties in classdef errors: no such file
* {{bug|52123}} Indirect memory leak in cdef_manager::initialize ()
* {{bug|51285}} max_recursion_depth error in classdef constructor
* {{bug|50395}} subclassing a class that is also defined as a variable fails
* {{bug|50011}} failure to report error on conflicting methods for classdef
* {{bug|49379}} classdef constructor: .argn. loses first argument, inputname(n) returns inputname(n+1)
* {{bug|55810}} sizeof() and whos() returns 0 bytes for classdef objects
* {{bug|45893}} classdef properties are not reloaded when file is updated
* {{bug|44643}} classdef handle object can go into an recursive loop with isequal(obj1,obj2) if both are self-referential
* {{bug|55755}} mxGetProperty does not work with properties marked as Dependent
* {{bug|55767}} classdef property should not be the same as classdef name (at least for Matlab compatibility)
* {{bug|44035}} unable to subclass built-in types
* {{bug|62432}} classdef object display of boolean matrix property fails with error message


* http://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/general/inputParser.m
==== Documentation ====
* https://github.com/markuman/go-redis
 
* https://github.com/PetrKryslUCSD/FinEALE
* {{bug|50729}} Improve OOP documentation
* {{bug|47908}} Octave:classdef-to-struct not documented in warning_ids.m
* {{bug|44590}} More documentation for the current status of classdef implementation
 
=== Classdef examples in Octave ===
 
* [https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/miscellaneous/inputParser.m inputParser.m]
* [https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/web/weboptions.m weboptions.m]
* [https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/%2Bcontainers/Map.m +containers/Map.m]
 
[[Category:Development]]

Latest revision as of 03:14, 23 November 2024

Supported Features[edit]

Properties[edit]

Classdef properties are supported but not all attributes are implemented.

Attribute Support Notes
AbortSet No Property does not exist.
Abstract Yes
Access Partial
Constant Yes
Dependent Partial
GetAccess Partial
GetObservable No Property exists but is not used. Requires events and listeners to be implemented in order to work properly.
Hidden Yes
NonCopyable No Property does not exist.
SetAccess Partial
SetObservable No Property exists but is not used. Requires events and listeners to be implemented in order to work properly.
Transient No Property exists but is not used.

Methods[edit]

Classdef methods are supported but not all attributes are fully implemented.

Attribute Support Notes
Abstract Partial See bug report #51377
Access Yes
Hidden Yes
Sealed Yes
Static Yes

Features that are not implemented[edit]

enumeration[edit]

  • #44582 Parse the enumeration section of a classdef definition but nothing is done with it.

events and listeners[edit]

  • #56194 Parse the events section of a classdef definition but nothing is done with it.

Property Validation Functions[edit]

Open Bug Reports for Other Issues[edit]

Issues with basic classdef functionality[edit]

  • #51659 Calling 'methods' on self causes syntax error
  • #52096 meta.class.fromName throws error when class name not found.
  • #55983 'x(ix) = []' deletion syntax does not work for objects
  • #55976 cat, repmat, and reshape don't work for classdef objects
  • #55961 properties function does not preserve order - Patch submitted, awaiting review
  • #52582 using static method to initialize property value fails
  • #45833 support load/save of classdef objects
  • #61676 Assigning classdef objects to other types does not call converter methods
  • #60729 print_usage within classdef constructor breaks subsequent calls to the class

Classdef and +package directories[edit]

  • 54941 interpreter cannot find methods in files of classdefs in packages

Arrays of classdef objects[edit]

  • #44665 error in concatenation of classdef objects
  • #53906 Cannot make an object array with square brackets
  • #47755 Access to object arrays
  • #47241 classdef: assigning property of handle object in object array constructs new object

Debugger (fixes for these are in progress)[edit]

  • #46451 unable to set breakpoints within classdef classes - Patch closed
  • #45404 Breakpoints cannot be set in classdef methods or +package function files - Report closed
  • #65610 unable to set breakpoints within set or get functions of classdef classes - Patch applied, ready for test

Lower-priority issues[edit]

  • #55488 Invalid use of colon char as classdef function's argument when subsref is overwritten
  • #54966 Error when assigning array to an object implementing subsasgn() subscripted using "{}"
  • #54028 copy of non-handle class instance is not deep
  • #53811 cellfun does not find overloaded function with function name argument
  • #52989 classdef: missing error messages on multiply defined properties
  • #52582 Dependent constant properties in classdef errors: no such file
  • #52123 Indirect memory leak in cdef_manager::initialize ()
  • #51285 max_recursion_depth error in classdef constructor
  • #50395 subclassing a class that is also defined as a variable fails
  • #50011 failure to report error on conflicting methods for classdef
  • #49379 classdef constructor: .argn. loses first argument, inputname(n) returns inputname(n+1)
  • #55810 sizeof() and whos() returns 0 bytes for classdef objects
  • #45893 classdef properties are not reloaded when file is updated
  • #44643 classdef handle object can go into an recursive loop with isequal(obj1,obj2) if both are self-referential
  • #55755 mxGetProperty does not work with properties marked as Dependent
  • #55767 classdef property should not be the same as classdef name (at least for Matlab compatibility)
  • #44035 unable to subclass built-in types
  • #62432 classdef object display of boolean matrix property fails with error message

Documentation[edit]

  • #50729 Improve OOP documentation
  • #47908 Octave:classdef-to-struct not documented in warning_ids.m
  • #44590 More documentation for the current status of classdef implementation

Classdef examples in Octave[edit]

Retrieved from "https://wiki.octave.org/wiki/index.php?title=Classdef&oldid=15242"