copy.m File Reference

Go to the source code of this file.

Functions
function	copy (in from, in to, in field, in exclude)
	Copy the contents of the struct/object from to the struct/object to recursively and without destroying the existing components in to. More...

Function Documentation

copy()

function copy	(	in	from,
		in	to,
		in	field,
		in	exclude
	)

Copy the contents of the struct/object from to the struct/object to recursively and without destroying the existing components in to.

Parameters

[in]	from	: The input scalar MATLAB struct whose (select) components must be copy/merged with the components of the input struct to.
[in]	to	: The input scalar MATLAB struct to which the components of from struct must be copied. (optional, default = struct())
[in]	field	: The input vector of MATLAB strings each element of which is a field or property name in from whose value has to be copied to the struct to. (optional, default = fieldnames(from) or properties(from))
[in]	exclude	: The input vector of MATLAB strings each element of which is a field or property name in from whose value has to be skipped and excluded from the copy to the struct to. (optional, default = [])

Returns

tonew : The output MATLAB struct containing the merger of the two input MATLAB structs.
If a field name in field is common between from and to, the field value of from will overwrite the corresponding field value of to in the output tonew.

Possible calling interfaces ⛓

tonew = pm.matlab.copy(from)
tonew = pm.matlab.copy(from, to)
tonew = pm.matlab.copy(from, [], field)
tonew = pm.matlab.copy(from, [], field, [])
tonew = pm.matlab.copy(from, to, field, [])
tonew = pm.matlab.copy(from, to, field, exclude)
tonew = pm.matlab.copy(from, to, [], exclude)
tonew = pm.matlab.copy(from, [], [], exclude)

Warning

If a name appears in both field and exclude input arguments, then it is excluded.

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('from = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);')
                from = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);
pm.matlab.show('to = struct("key1", "val1", "Key2", "Val2");')
                to = struct("key1", "val1", "Key2", "Val2");
 
pm.matlab.show()
pm.matlab.show('new = pm.matlab.copy(from);')
                new = pm.matlab.copy(from);
pm.matlab.show('new')
pm.matlab.show( new )
 
pm.matlab.show()
pm.matlab.show('new = pm.matlab.copy(from, [], "key3");')
                new = pm.matlab.copy(from, [], "key3");
pm.matlab.show('new')
pm.matlab.show( new )
 
pm.matlab.show()
pm.matlab.show('new = pm.matlab.copy(from, to, "key3");')
                new = pm.matlab.copy(from, to, "key3");
pm.matlab.show('new')
pm.matlab.show( new )
 
pm.matlab.show()
pm.matlab.show('new = pm.matlab.copy(from, to);')
                new = pm.matlab.copy(from, to);
pm.matlab.show('new')
pm.matlab.show( new )

Example output ⛓

 
from = struct("key1", 1, "key2", "val2", "Key2", "val2duplicate", "key3", false, "key4", []);
to = struct("key1", "val1", "Key2", "Val2");
 
new = pm.matlab.copy(from);
new
new.key1
     1
new.key2
val2
new.Key2
val2duplicate
new.key3
   0
new.key4
 
new = pm.matlab.copy(from, [], "key3");
new
new.key3
   0
 
new = pm.matlab.copy(from, to, "key3");
new
new.key1
val1
new.Key2
Val2
new.key3
   0
 
new = pm.matlab.copy(from, to);
new
new.key1
     1
new.Key2
val2duplicate
new.key2
val2
new.key3
   0
new.key4

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:59 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