Skip to content

Updates naming convention for main RAT variables#194

Merged
DrPaulSharp merged 9 commits intoRascalSoftware:masterfrom
DrPaulSharp:variables
Jan 26, 2024
Merged

Updates naming convention for main RAT variables#194
DrPaulSharp merged 9 commits intoRascalSoftware:masterfrom
DrPaulSharp:variables

Conversation

@DrPaulSharp
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@StephenNneji StephenNneji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see comments

API/RAT.m Outdated
@@ -1,44 +1,42 @@
function [outProblemDef,result] = RAT(problemDefInput,controls)
function [project,result] = RAT(project,inputControls)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think RAT(project, controls) is a better signature than RAT(project, inputControls) especially since this is the user facing function

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to capture the fact that the controls are converted from a class object to a struct, but I'll take another look.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the lesser evil here is to leave it as controls throughout, despite the change in type. What do you think?

function [fitPars,fitNames,fitConstr] = getFitValues(inputProblem,controls)

[problemDef,problemDef_cells,problemDef_limits,priors,controls] = RatParseClassToStructs_new(inputProblem,controls);
[problemStruct,problemCells,problemLimits,~,controls] = parseClassToStructs(inputProblem,controls);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is inputProblem meant to be project?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I largely left the examples as they are being replaced.

@DrPaulSharp DrPaulSharp merged commit ea1b43a into RascalSoftware:master Jan 26, 2024
@DrPaulSharp DrPaulSharp deleted the variables branch January 26, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants