File Exchange

image thumbnail

detectOutputSuppres​sion

version 2.0.0 (14 KB) by Adam Danz
Identify which function outputs have been suppressed by the caller using the tilde operators.

5 Downloads

Updated 15 Sep 2020

View License

When a function is called with tilde operators in the outputs, those outputs are suppressed, even if the function computes their values.

Call detectOutputSuppression from within a function to detect which outputs have been suppressed by the caller.

ISTILDE= detectOutputSuppression(nargout)
Returns a logical vector identifying which outputs were suppressed by the caller using the tilde operators.
Matlab's nargout function is a required input and indicates the number of expected outputs.

[ISTILDE, CALLERTXT, CALLER, COMPONENTS] = detectOutputSuppression(nargout)
Returns additional information about the caller and the outputs it requested including the variable names.

detectOutputSuppression_tester() contains 84 examples that stress tests the detectOutputSuppression function using a wide variety of syntaxes and ensures the correct outputs and expected error messages are generated.

EXAMPLE
----------------------
function main()
[mst(1), ~, ~, data] = myFunc();

function [a, b, c, d] = myFunc()
a = 1; b = 2; c = 3; d = 4;
[ISTILDE, CALLERTXT, CALLER, COMPONENTS] = detectOutputSuppression(nargout)

Results:
ISTILDE = [0 1 1 0]
CALLERTXT = '[mst(1), ~, ~, data] = myFunc();'
CALLER is the caller stack info.
COMPONENTS contains information about the output names used by the caller.

See help('detectOutputSuppression') for a list of requirements and restrictions.

* Note that there are cleaner alternatives to this function.
1. Add an input to your function that specifies which outputs are requested.
2. Prioritize the function outputs.

Tested and fully functional in Matlab r2014a, 16a, 16b, 17b, 19b, and r2020a.

Cite As

Adam Danz (2020). detectOutputSuppression (https://www.mathworks.com/matlabcentral/fileexchange/79218-detectoutputsuppression), MATLAB Central File Exchange. Retrieved .

Comments and Ratings (1)

Rik

I like seeing well-documented functions with included testers. Have some stars from me.

Updates

2.0.0

Increased rigor in detecting parsing errors and unsupported syntaxes. Greater flexibility. Added tester function for stress testing.

1.2.0

Function outputs must be separated by a comma within the caller.

1.0.1

Added source link to the documentation.

MATLAB Release Compatibility
Created with R2020a
Compatible with R2014a to any release
Platform Compatibility
Windows macOS Linux