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.

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

Rearrange exports; deprecate lambdamin, lambdamax #357

Merged
merged 7 commits into from
Jan 13, 2020
Merged

Conversation

ericphanson
Copy link
Collaborator

I'm thinking about the API we should expose in Convex.jl v0.13 (see #346), and realized it's hard to know what API we expose now, since the exports are scattered across files.

I've therefore moved them all to the top of src/Convex.jl. I also unexported many functions that I feel should be internal:

  • All types corresponding to Atoms (these should be constructed via functions, e.g. using + instead of AdditionAtom)
  • All types corresponding to constraints and vexities (these likewise be automatically constructed from the exposed API)
  • Base.to_index, promote_size, get_row, conic_form!, Value, ValueOrNothing, which just don't seem to need to be exported
  • Functions already exported from Base

I have left the re-exports from LinearAlgebra, though maybe we should revisit that (maybe a user should need to do using LinearAlgebra in order to get e.g. norm and eigmin).

I also deprecated lambdamin and lambdamax in favor of LinearAlgebra.eigmin and LinearAlgebra.eigmax, which closes #336.

@ericphanson ericphanson merged commit 9578b9c into master Jan 13, 2020
@ericphanson ericphanson deleted the rearrange branch March 1, 2020 00:33
@ericphanson ericphanson mentioned this pull request Mar 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

lambdamin and lambdamax should be eigmin and eigmax?
1 participant