-
Notifications
You must be signed in to change notification settings - Fork 11
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.
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
Major code reorganization #1
Open
lostella
wants to merge
16
commits into
master
Choose a base branch
from
new-functions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this branch is becoming serious
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DO NOT MERGE: work in progress
This PR cleans and reorganizes the code into packages, rather than scattered m-files in
private/
andlibrary/
. The idea is to organize the code in theforbes
package (`+forbes/' folder), and:forbes.functions
package (+forbes/+functions/
folder): classes encoding the mathematical functions to be used to define problems;forbes.fbe
package (+forbes/+fbe/
folder): utility classes for evaluating forward-backward steps and the FBE;forbes.problems
package (+forbes/+problems/
folder): classes representing problems;forbes.utils
package (+forbes/+utils/
folder): various utilities;forbes.tests
package (+forbes/+tests/
folder): test scripts.The end user really cares about the
forbes.functions
package, which is used to constructs the terms defining the problem to be solved.TODO
Many mathematical functions previously in
library/
were already ported into theforbes.functions
package, but not all of them. Furthermore, solvers-related code is still inprivate/
. Therefore, before merging, we should:forbes.functions
package;private/
to aforbes.solvers
package.What's next
Solvers should be a lot more readable. I guess one way to do that is to use classes also there: store the state of the algorithm into properties, and have methods
initialize
,iterate
(which runs one iteration) andstop
(that checks the stopping condition).