Explain how linear constraints are handled
Open
Nobody has claimed this yet.
documentation
stale
- Dominant language
- Python
- Stars
- 270
- Forks
- 123
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 3
Description
Type of issue
What types of issue is it?
Select the appropriate type(s) that describe this issue
- Documentation update
Description
The documentation should explain more clearly how the linear constraints are handled.
- They do not need to be computed in funcs/sens
- The Jacobian MUST be supplied (either dense or sparse format)
- The constraint values are NOT stored in the history file, but the Jacobian is stored as part of
optProb
Contributor guide
No contributing guide indexed for this repository
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 documentation covering linear constraints, funcs/sens, the history file, and optProb. Clarify that linear constraints do not need to be computed in funcs/sens, that a dense or sparse Jacobian is required, and that constraint values are not stored in the history file while the Jacobian is stored in optProb.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100