struct2hash.m File Reference

Go to the source code of this file.

Functions
function	struct2hash (in object, in exkeys, in unique, in onlyfull)
	Return a hashmap cell array containing all field names and field values of input scalar MATLAB object as (key, val) stored sequentially in the cell array. More...

Function Documentation

struct2hash()

function struct2hash	(	in	object,
		in	exkeys,
		in	unique,
		in	onlyfull
	)

Return a hashmap cell array containing all field names and field values of input scalar MATLAB object as (key, val) stored sequentially in the cell array.

Parameters

[in]	object	: The input scalar MATLAB struct whose field names and values are to be converted to a hashmap cell.
[in]	exkeys	: The input vector of MATLAB strings containing a list of field names of the input object that must be excluded from the output hashmap cell. (optional, default = [])
[in]	unique	: The input scalar MATLAB logical. If true, only the first instance of occurrence of any field name is added to the output cell array without considering case-sensitivity of the field names. (optional, default = false)
[in]	onlyfull	: The input scalar MATLAB logical. If true, only the structure field names field values are nonempty (as assessed by the MATLAB intrinsic isempty()) are included in the output hashmap. (optional, default = false)

Returns

hashmap : The output cell array of even number of elements containing the field names and values of the input object as (key, val) pairs stored sequentially as the cell elements.

Possible calling interfaces ⛓

hashmap = pm.matlab.hashmap.struct2hash(object)
hashmap = pm.matlab.hashmap.struct2hash(object, exkeys)
hashmap = pm.matlab.hashmap.struct2hash(object, [], unique)
hashmap = pm.matlab.hashmap.struct2hash(object, exkeys, unique)
hashmap = pm.matlab.hashmap.struct2hash(object, exkeys, [], onlyfull)
hashmap = pm.matlab.hashmap.struct2hash(object, [], unique, onlyfull)
hashmap = pm.matlab.hashmap.struct2hash(object, exkeys, unique, onlyfull)
hashmap = pm.matlab.hashmap.struct2hash(object, [], [], onlyfull)
hashmap = pm.matlab.hashmap.struct2hash(object, [], [], [])

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.matlab.show()
pm.matlab.show('s = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);')
                s = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);
 
pm.matlab.show()
pm.matlab.show('hashmap = pm.matlab.hashmap.struct2hash(s);')
                hashmap = pm.matlab.hashmap.struct2hash(s);
pm.matlab.show('hashmap')
pm.matlab.show( hashmap )
 
pm.matlab.show()
pm.matlab.show('hashmap = pm.matlab.hashmap.struct2hash(s, "key1");')
                hashmap = pm.matlab.hashmap.struct2hash(s, "key1");
pm.matlab.show('hashmap')
pm.matlab.show( hashmap )
 
pm.matlab.show()
pm.matlab.show('hashmap = pm.matlab.hashmap.struct2hash(s, [], true);')
                hashmap = pm.matlab.hashmap.struct2hash(s, [], true);
pm.matlab.show('hashmap')
pm.matlab.show( hashmap )
 
pm.matlab.show()
pm.matlab.show('hashmap = pm.matlab.hashmap.struct2hash(s, "key1", true);')
                hashmap = pm.matlab.hashmap.struct2hash(s, "key1", true);
pm.matlab.show('hashmap')
pm.matlab.show( hashmap )
 
pm.matlab.show()
pm.matlab.show('hashmap = pm.matlab.hashmap.struct2hash(s, "key1", [], true);')
                hashmap = pm.matlab.hashmap.struct2hash(s, "key1", [], true);
pm.matlab.show('hashmap')
pm.matlab.show( hashmap )

Example output ⛓

 
s = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);
 
hashmap = pm.matlab.hashmap.struct2hash(s);
hashmap
hashmap{1}
key1
hashmap{2}
     1
hashmap{3}
key2
hashmap{4}
val2
hashmap{5}
Key2
hashmap{6}
val2duplicate
hashmap{7}
key3
hashmap{8}
   0
hashmap{9}
key4
hashmap{10}
 
hashmap = pm.matlab.hashmap.struct2hash(s, "key1");
hashmap
hashmap{1}
key2
hashmap{2}
val2
hashmap{3}
Key2
hashmap{4}
val2duplicate
hashmap{5}
key3
hashmap{6}
   0
hashmap{7}
key4
hashmap{8}
 
hashmap = pm.matlab.hashmap.struct2hash(s, [], true);
hashmap
hashmap{1}
key1
hashmap{2}
     1
hashmap{3}
key2
hashmap{4}
val2
hashmap{5}
key3
hashmap{6}
   0
hashmap{7}
key4
hashmap{8}
 
hashmap = pm.matlab.hashmap.struct2hash(s, "key1", true);
hashmap
hashmap{1}
key2
hashmap{2}
val2
hashmap{3}
key3
hashmap{4}
   0
hashmap{5}
key4
hashmap{6}
 
hashmap = pm.matlab.hashmap.struct2hash(s, "key1", [], true);
hashmap
hashmap{1}
key2
hashmap{2}
val2
hashmap{3}
Key2
hashmap{4}
val2duplicate
hashmap{5}
key3
hashmap{6}
   0

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 10:56 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin