Simple Input Parser code samples

basic_use_case.m

function ret = my_function(varargin)

    params.a = 42;
    params.b = 'answer';
    params.c = 55.3;

    params = simple_input_parser(params, varargin);

    % further functionalities that uses the params struct

end

bulk_mode.m

ssin('A f L fs phi', 2, 440, 0.8, 48e3, 45)

bulk_mode_no_spaces.m

ssin('AfLfsphi', 2, 440, 0.8, 48e3, 45)

extra_flag_mode.m

function ret = my_function(varargin)

    params.a = 0;
    params.b = 0;
    params.c = 0;

    [params, flags] = simple_input_parser(params, varargin);

    if flags.b
        disp('b parameter was passed');
    end

    % further functionalities
end

key_value_pair_mode.m

ssin('f', 440, 'A', 2, 'phi', 45, 'fs', 48e3, 'L', 0.8)

old_way.m

% use this function to generate a sine wave
ssin(440, 2, 45, 48e3, 0.8)

tests.txt

Running SimpleInputParserTests
..........
..........
..........
...
Done SimpleInputParserTests
__________

                 result              
    _________________________________

    [1x33 matlab.unittest.TestResult]

validator_function_example.m

function [validflag, errormsg] = my_validator_for_the_parameter_c(value)
    validflag = value > 1;
    errormsg = 'Parameter c has to be greater than 1..';
end

validator_function_use_case.m

function ret = my_function(varargin)

    params.a = 0;
    params.b = 0;
    params.c = 0;

    function [validflag, errormsg] = my_validator_for_the_parameter_c(value)
        validflag = value > 1;
        errormsg = 'Parameter c has to be greater than 1..';
    end

    validators.c = @validate_c;

    params = simple_input_parser(params, varargin, validators);

    % further functionalities

end