MATLAB-utilities/spgd_eval_plot.m at master · nickersonm/MATLAB-utilities · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
%% spgd_eval_plot.m  MN 2025-02-27
% Plot SPGD evaluation
%  (c) Michael Nickerson 2025
%
% Usage: spgd_eval_plot(coeff, J, [, option, [value]])
%   Parameters:
%     coeff: coefficient value(s)
%     J: function value
%
%     Options:
%       'figure', %i: plot to specified figure handle (default 1)
%
% TODO:
%   x Initial implementation
%   x Test

function spgd_eval_plot(coeff, J, varargin)
%% Defaults and magic numbers
figN = 1;


%% Argument parsing
% Check required inputs
if isempty(coeff) || ~isa(coeff, "double")
    error('Required input "coeff" is not a double!');
end
if isempty(J) || ~isa(J, "double")
    error('Required input "J" is not a double!');
end

% Accept a struct.option = value structure
if numel(varargin) > 0 && isstruct(varargin{1})
    paramStruct = varargin{1}; varargin(1) = [];
    varargin = [reshape([fieldnames(paramStruct) struct2cell(paramStruct)]', 1, []), varargin];
end

% Parameter parsing
while ~isempty(varargin)
    arg = lower(varargin{1}); varargin(1) = [];
    if isempty(arg); continue; end

    % Look for valid arguments
    switch arg
        case {'fig', 'figure'}
            figN = nextarg('figure number');
        otherwise
            if ~isempty(arg)
                warning('Unexpected option "%s", ignoring', num2str(arg));
            end
    end
end


%% Helper functions, if any
    % Get the next argument or error
    function arg = nextarg(strExpected)
        if isempty(strExpected); strExpected = ''; end
        if ~isempty(varargin)
            arg = varargin{1}; varargin(1) = [];
        else
            error('Expected next argument "%s", but no more arguments present!', strExpected);
        end
    end


%% 2-axis plot
if gcf().Number ~= figN
    figure(figN);
end

% Plot coeffs
yyaxis left;
grid on;
ax = gca();

if numel(ax.Children) ~= numel(coeff) || any(cell2mat(cellfun(@size, {ax.Children.XData}, 'UniformOutput', false)) ~= cell2mat(cellfun(@size, {ax.Children.YData}, 'UniformOutput', false)))
    clf; yyaxis left;
    hold on;
    for i = 1:numel(coeff)
        plot(1, NaN);
    end
    hold off;
end
ax = gca();
for i=1:numel(coeff)
    [ax.Children(i).XData(end+1), ax.Children(i).YData(end+1)] = ...
        deal(ax.Children(i).XData(end) + 1, coeff(i));
end

% Plot J
yyaxis right;
ax = gca();

if numel(ax.Children) ~= numel(J) || any(cell2mat(cellfun(@size, {ax.Children.XData}, 'UniformOutput', false)) ~= cell2mat(cellfun(@size, {ax.Children.YData}, 'UniformOutput', false)))
    hold on;
    for i = 1:numel(J)
        plot(1, NaN);
    end
    hold off;
end
ax = gca();
for i=1:numel(J)
    [ax.Children(i).XData(end+1), ax.Children(i).YData(end+1)] = ...
        deal(ax.Children(i).XData(end) + 1, J(i));
end

drawnow limitrate;

end