DataSet Object Methods: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy No edit summary |
imported>Jeremy |
||
Line 16: | Line 16: | ||
===Methods Defined or Overloaded for DataSet Objects=== | ===Methods Defined or Overloaded for DataSet Objects=== | ||
:[[dataset_cat|cat]] - Generic concatenation of DataSet objects. | |||
:[[dataset_cat|cat]] | :[[dataset_delsamps|delsamps]] - Deletes or excludes the specified samples, rows, or other dimension from a DataSet object. | ||
:[[dataset_delsamps|delsamps]] | :[[dataset_disp|disp]] - Display summary of DataSet object contents. | ||
:[[dataset_disp|disp]] | :[[dataset_explode|explode]] - Extract all variables from a DataSet object. | ||
:[[dataset_explode|explode]] | :[[dataset_get|get]] - Get field/property values from a DataSet object. | ||
:[[dataset_get|get]] | :[[dataset_horzcat|horzcat]] - Horizontal concatenation of DataSet objects. | ||
:[[dataset_horzcat|horzcat]] | :[[dataset_isempty|isempty]] - Returns Boolean true if the DataSet object data field is empty. | ||
:[[dataset_isempty|isempty]] | :[[dataset_length|length]] - Returns the length of the data field in a DataSet object. | ||
:[[dataset_length|length]] | :[[dataset_ndims|ndims]] - Returns the number of dimensions of the data field in a DataSet object. | ||
:[[dataset_ndims|ndims]] | :[[dataset_numel|numel]] - Returns a value of 1 for any dataset object. | ||
:[[dataset_numel|numel]] | :[[dataset_permute|permute]] - Permute array dimensions of a DataSet object. | ||
:[[dataset_permute|permute]] | :[[dataset_repmat|repmat]] - Replicate and tile a DataSet object. | ||
:[[dataset_repmat|repmat]] | :[[dataset_set|set]] - Set field/property values for a DataSet object. | ||
:[[dataset_set|set]] | :[[dataset_size|size]] - Returns the size of the data field in a DataSet object. | ||
:[[dataset_size|size]] | :[[dataset_sortby|sortby]] - Sort a DataSet by given field, dim, and set. | ||
:[[dataset_sortby|sortby]] | :[[dataset_sortcols|sortcols]] - Sort columns of a DataSet. | ||
:[[dataset_sortcols|sortcols]] | :[[dataset_sortrows|sortrows]] - Sort rows of a DataSet. | ||
:[[dataset_sortrows|sortrows]] | :[[dataset_squeeze|squeeze]] - Removes singleton dimensions of a DataSet object. | ||
:[[dataset_squeeze|squeeze]] | :[[dataset_subsasgn|subsasgn]] - Assign for DataSet objects using Structure and index notation. | ||
:[[dataset_subsasgn|subsasgn]] | :[[dataset_subsref|subsref]] - Subindex for DataSet objects using Structure and index notation. | ||
:[[dataset_subsref|subsref]] | :[[dataset_transpose|transpose]] - Performs a transpose (rows become columns and columns become rows) on a two-way DataSet object. | ||
:[[dataset_transpose|transpose]] | :[[dataset_unique|unique]] - Returns a DataSet object containing all the unique values from the input. | ||
:[[dataset_unique|unique]] | :[[dataset_vertcat|vertcat]] - Returns a DataSet object containing all the unique values from the input | ||
:[[dataset_vertcat|vertcat]] | |||
Revision as of 10:06, 13 October 2008
In addition to the specific methods listed below, a number of standard MATLAB functions are overloaded for DataSet objects but otherwise work as documented for standard data types. The following methods operate on the underlying data field of a DataSet object only and have no effect on any other fields:
- minus (-)
- plus (+)
- times (.*)
- rdivide (./)
- ldivide (.\)
- double
- single
To get help on any DataSet object method, use the command: help dataset/method where method is the name of the method for which you want help.
Methods Defined or Overloaded for DataSet Objects
- cat - Generic concatenation of DataSet objects.
- delsamps - Deletes or excludes the specified samples, rows, or other dimension from a DataSet object.
- disp - Display summary of DataSet object contents.
- explode - Extract all variables from a DataSet object.
- get - Get field/property values from a DataSet object.
- horzcat - Horizontal concatenation of DataSet objects.
- isempty - Returns Boolean true if the DataSet object data field is empty.
- length - Returns the length of the data field in a DataSet object.
- ndims - Returns the number of dimensions of the data field in a DataSet object.
- numel - Returns a value of 1 for any dataset object.
- permute - Permute array dimensions of a DataSet object.
- repmat - Replicate and tile a DataSet object.
- set - Set field/property values for a DataSet object.
- size - Returns the size of the data field in a DataSet object.
- sortby - Sort a DataSet by given field, dim, and set.
- sortcols - Sort columns of a DataSet.
- sortrows - Sort rows of a DataSet.
- squeeze - Removes singleton dimensions of a DataSet object.
- subsasgn - Assign for DataSet objects using Structure and index notation.
- subsref - Subindex for DataSet objects using Structure and index notation.
- transpose - Performs a transpose (rows become columns and columns become rows) on a two-way DataSet object.
- unique - Returns a DataSet object containing all the unique values from the input.
- vertcat - Returns a DataSet object containing all the unique values from the input