Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaces the essential fprintf with message events #261

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Replaces the essential fprintf with message events #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b6e8e7
Replaces the essential fprintf with message events
StephenNneji Aug 20, 2024
16a5249
Adresses review comment
StephenNneji Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions API/RATMain.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@
result = reflectivityCalculation(problemStruct,problemCells,problemLimits,controls);
case coderEnums.procedures.Simplex
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('\nRunning simplex\n\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('\nRunning simplex\n\n'));
end
[problemStruct,result] = runSimplex(problemStruct,problemCells,problemLimits,controls);
case coderEnums.procedures.DE
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('\nRunning Differential Evolution\n\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('\nRunning Differential Evolution\n\n'));
end
[problemStruct,result] = runDE(problemStruct,problemCells,problemLimits,controls);
case coderEnums.procedures.NS
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('\nRunning Nested Sampler\n\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('\nRunning Nested Sampler\n\n'));
end
[problemStruct,result,bayesResults] = runNestedSampler(problemStruct,problemCells,problemLimits,controls,priors);
case coderEnums.procedures.Dream
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('\nRunning DREAM\n\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('\nRunning DREAM\n\n'));
end
[problemStruct,result,bayesResults] = runDREAM(problemStruct,problemCells,problemLimits,controls,priors);
otherwise
Expand Down
11 changes: 6 additions & 5 deletions minimisers/DE/deopt.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@
%-----Check input variables---------------------------------------------
if (I_NP < 5)
I_NP=5;
fprintf(1,' I_NP increased to minimal value 5\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('I_NP increased to minimal value 5\n'));
end
if ((F_CR < 0) | (F_CR > 1))
F_CR=0.5;
fprintf(1,'F_CR should be from interval [0,1]; set to default value 0.5\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('F_CR should be from interval [0,1]; set to default value 0.5\n'));
end
if (I_itermax <= 0)
I_itermax = 200;
fprintf(1,'I_itermax should be > 0; set to default value 200\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('I_itermax should be > 0; set to default value 200\n'));
end
I_refresh = floor(I_refresh);

Expand Down Expand Up @@ -305,7 +305,8 @@

if (I_refresh > 0)
if ((rem(I_iter,I_refresh) == 0) || I_iter == 1) && strcmpi(controls.display, coderEnums.displayOptions.Iter)
fprintf('Iteration: %g, Best: %f, fWeight: %f, F_CR: %f, I_NP: %g\n\n', I_iter,S_bestval.FVr_oa(1),fWeight,F_CR,I_NP);
triggerEvent(coderEnums.eventTypes.Message, ...
sprintf('Iteration: %g, Best: %f, fWeight: %f, F_CR: %f, I_NP: %g\n\n', I_iter,S_bestval.FVr_oa(1),fWeight,F_CR,I_NP));

%disp(S_bestval);
%var(FM_pop)
Expand All @@ -328,7 +329,7 @@

if isRATStopped(controls.IPCFilePath)
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('Optimisation terminated by user\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('Optimisation terminated by user\n'));
end
break;
end
Expand Down
2 changes: 1 addition & 1 deletion minimisers/DE/runDE.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
result = reflectivityCalculation(problemStruct,problemCells,problemLimits,controls);

if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('Final chi squared is %g\n',result.calculationResults.sumChi);
triggerEvent(coderEnums.eventTypes.Message, sprintf('Final chi squared is %g\n',result.calculationResults.sumChi));
end

end
Expand Down
33 changes: 29 additions & 4 deletions minimisers/DREAM/functions/ratDREAM.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,7 @@
% Now print to screen all the settings
controls = ratInputs.controls;
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('------------------ Summary of the main settings used ------------------\n');
disp(DREAMPar);
fprintf('-----------------------------------------------------------------------\n');
printParameters(DREAMPar);
end
% Now check how the measurement sigma is arranged (estimated or defined)
%
Expand Down Expand Up @@ -276,7 +274,7 @@

if isRATStopped(controls.IPCFilePath)
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('Optimisation terminated by user\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('Optimisation terminated by user\n'));
end
break;
end
Expand All @@ -300,3 +298,30 @@
triggerEvent(coderEnums.eventTypes.Progress, 'DREAM', 1);
%close(h);
end


function printParameters(DREAMPar)
% Print the dream parameters
coder.varsize('setting', [1 Inf], [0 1]);
setting = sprintf('------------------ Summary of the main settings used ------------------\n');
names = fieldnames(DREAMPar);
bools = {'false', 'true'};
for k=1:numel(names)
setting = strjoin({setting, sprintf('%25s: ', names{k})});
value = DREAMPar.(names{k});
if isnumeric(value)
if numel(value) ~= 1
dim = size(value);
setting = strjoin({setting, sprintf('[%gx%g %s]\n', dim(1), dim(2), class(value))});
else
setting = strjoin({setting, sprintf('%.8g\n', value(1))});
end
elseif islogical(value)
setting = strjoin({setting, sprintf('%s\n', bools{double(value) + 1})});
else
setting = strjoin({setting, sprintf('''%s''\n', value)});
end
end
setting = strjoin({setting, sprintf('-----------------------------------------------------------------------\n')});
triggerEvent(coderEnums.eventTypes.Message, setting);
end
2 changes: 1 addition & 1 deletion minimisers/DREAM/functions/removeOutlier.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
else
if N >= 61
N = 60; n_ind = size(peirce_r,1);
fprintf('DREAMPar.nChains > 60; using Peirce r-values for DREAMPar.nChains is 60');
triggerEvent(coderEnums.eventTypes.Message, 'DREAMPar.nChains > 60; using Peirce r-values for DREAMPar.nChains is 60');
end
if N < 2
error('Insufficient number of chains to apply Peirce diagnostic');
Expand Down
2 changes: 1 addition & 1 deletion minimisers/NS/drawMCMC.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@

% print out acceptance ratio
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('Acceptance ratio: %1.4f, \n\n', acctot/(Ntimes*nMCMC));
triggerEvent(coderEnums.eventTypes.Message, sprintf('Acceptance ratio: %1.4f, \n\n', acctot/(Ntimes*nMCMC)));
end

return
6 changes: 3 additions & 3 deletions minimisers/NS/nestedSampler.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,12 +271,12 @@

% display progress (optional)
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('log(Z): %.5e, tol = %.5e, K = %d, iteration = %d, H = %.5e\n', ...
logZ, tol, int32(K), int32(j), H);
triggerEvent(coderEnums.eventTypes.Message, sprintf('log(Z): %.5e, tol = %.5e, K = %d, iteration = %d, H = %.5e\n', ...
logZ, tol, int32(K), int32(j), H));
end
if isRATStopped(controls.IPCFilePath)
if ~strcmpi(controls.display, coderEnums.displayOptions.Off)
fprintf('Optimisation terminated by user\n');
triggerEvent(coderEnums.eventTypes.Message, sprintf('Optimisation terminated by user\n'));
end
break;
end
Expand Down
16 changes: 9 additions & 7 deletions minimisers/simplex/fMinSearch.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,9 @@

% Print out initial f(x) as 0th iteration
if prnt == 3
fprintf('\n%s\n', header);
fprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how);
triggerEvent(coderEnums.eventTypes.Message, sprintf('\n%s\n', header));
triggerEvent(coderEnums.eventTypes.Message, ...
sprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how));
% elseif prnt == 4
% Option never used in RAT

Expand Down Expand Up @@ -299,7 +300,8 @@
itercount = itercount + 1;
func_evals = n+1;
if prnt == 3
fprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how);
triggerEvent(coderEnums.eventTypes.Message, ...
sprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how));
% elseif prnt == 4
% fprintf('%s \n', ' ')
% fprintf('%s \n', how)
Expand Down Expand Up @@ -418,7 +420,7 @@
v = v(:,j);
itercount = itercount + 1;
if prnt == 3
fprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how);
triggerEvent(coderEnums.eventTypes.Message, sprintf(' %5.0f %5.0f %12.6g %s\n', itercount, func_evals, fv(1), how));
% elseif prnt == 4
% fprintf('%s \n', ' ')
% fprintf('%s \n', num2str(how))
Expand Down Expand Up @@ -490,7 +492,7 @@
end

if printMsg
fprintf('\n%s\n', msg);
triggerEvent(coderEnums.eventTypes.Message, sprintf('\n%s\n', msg));
end
end
%--------------------------------------------------------------------------
Expand Down Expand Up @@ -541,9 +543,9 @@
output.iterations = iteration;
output.funcCount = funccount;
output.algorithm = 'Nelder-Mead simplex direct search';
output.message = sprintf('Optimisation terminated by user');
output.message = 'Optimisation terminated by user';
if display > 0
fprintf('\n%s\n', output.message);
triggerEvent(coderEnums.eventTypes.Message, sprintf('\n%s\n', output.message));
end
end

Expand Down