JuliaControl / JuliaControl/ModelPredictiveControl.jl
Potential breaking changes for a v3
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 135
- Forks
- 9
- Avg merge
- 17h 35m
- Merged PRs (30d)
- 16
Description
I'm raising an issue to list the possible breaking changes for a future release of a v2 v3 library:
- Removing
oraclekeyword argument and code in the twolegacy.jlfiles - Adding the slack $\epsilon$ in the signature of $J_E$ function (to support non-quadratic weighting)
- Consider changing the default arguments of
UnscentedKalmanFilter - Consider changing the default value of
transcriptioninNonLinMPCtoMultilpleShooting
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the two legacy.jl files and the APIs for J_E, UnscentedKalmanFilter, and NonLinMPC. Resolve the two unchecked decisions about default arguments and transcription, then document the agreed v3 breaking changes and update the affected interfaces.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100