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

WIP: break everything, new docs #173

Closed
wants to merge 99 commits into from
Closed

WIP: break everything, new docs #173

wants to merge 99 commits into from

Conversation

mlubin
Copy link
Member

@mlubin mlubin commented Jun 14, 2017

Beginning of a rewrite of the docs using Documenter (#169), incorporating status changes (#164) and a new attribute concept.

We'll use this as the starting point for the documentation tutorial tomorrow.

Preview of the documentation: http://www.juliaopt.org/MathProgBase.jl/latest/

@chriscoey chriscoey added this to the 1.0 milestone Jun 14, 2017
@chriscoey chriscoey added the docs label Jun 14, 2017
dimension(s::Interval) = 1

"""
addconstraint!(m::AbstractMathProgModel, b, a_varidx, a_coef, Q_vari, Q_varj, Q_val, S::AbstractSet)
Copy link
Member

Choose a reason for hiding this comment

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

s/a_coef/a_val

```
where ``a`` is a sparse vector specified in tuple form by
`a_varidx`, and `a_val`; ``b`` is a scalar;
the symmetric matrix ``Q_i`` is defined by the triplets in `Q_vari`, `Q_varj`,
Copy link
Member

Choose a reason for hiding this comment

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

s/Q_i/Q

"""
getattribute!(output, m::AbstractMathProgModel, attr::AbstractAttribute)

An in-place version of `getattribute!`. Return an attribute of the model `m` specified by attribute type `attr` into output vector `attr`.
Copy link
Member

Choose a reason for hiding this comment

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

s/getattribute!/getattribute

"""
VariablePrimal(N)

The assignment to the primal variables in result `N`. If `N` is omitted, it is interpreted as 1.
Copy link
Member

Choose a reason for hiding this comment

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

Is the plan to implement this with a VariablePrimal() = VariablePrimal(1) constructor?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah that works.

```@docs
AbstractAttribute
cangetattribute
getattribute
Copy link
Member

Choose a reason for hiding this comment

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

getattribute! is missing here

duplicate terms. `a_varidx`, `Q_vari`, `Q_varj` should be collections of
`VariableReference` objects.
"""
function setobjective! end
Copy link
Member

Choose a reason for hiding this comment

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

Worth having a method that only adds the linear part? We could have a fallback method in MPB to fill in the empty quadratic part

setobjective!(m::AbstractMathProgModel, N::Int, b, a_varidx, a_coef)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that's a TODO

@mlubin
Copy link
Member Author

mlubin commented Jun 16, 2017

TODO: for constraint attributes, cangetattribute should take the constraint reference.

mlubin and others added 5 commits June 16, 2017 18:34
* preliminary migration of nlp tests

* WIP: adding first conic example
* tests

* more test

* MOre testing

* more tests

* More tests
@mlubin
Copy link
Member Author

mlubin commented Jun 29, 2017

I'm planning on moving this branch into a new package. Potential names: MathOptAPI (MOA) (@odow) and MathOptInterface

Given that NLP is still half-baked and doesn't play well with the new design, we can leave MPB around for NLP solvers until we have a good unified API for it.

@odow
Copy link
Member

odow commented Jun 29, 2017

You're stealing my name! Although I've been leaning more to Kōkako.jl recently...

mlubin added a commit to jump-dev/MathOptInterface.jl that referenced this pull request Jun 30, 2017
JuliaOpt/MathProgBase.jl#173
Includes contributions from:
Site Wang <[email protected]>
Joey Huchette <[email protected]>
joaquimgarcia_psr <[email protected]>
odow <[email protected]>
ccoffrin <[email protected]>
Benoît Legat <[email protected]>
Chris Coey <[email protected]>
@mlubin
Copy link
Member Author

mlubin commented Jun 30, 2017

Development will continue here: https://github.com/JuliaOpt/MathOptInterface.jl

@mlubin mlubin closed this Jun 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants