Merge pull request #357 from JuliaOpt/rearrange

Rearrange exports; deprecate `lambdamin`, `lambdamax`
jump-dev · Jan 13, 2020 · 9578b9c · 9578b9c
2 parents 8bf8b53 + f93e340
commit 9578b9c
Show file tree

Hide file tree

Showing 70 changed files with 80 additions and 170 deletions.
diff --git a/docs/examples_literate/general_examples/basic_usage.jl b/docs/examples_literate/general_examples/basic_usage.jl
@@ -81,7 +81,7 @@ x.value
 
 
 y = Semidefinite(2)
-p = maximize(lambdamin(y), tr(y)<=6)
+p = maximize(eigmin(y), tr(y)<=6)
 solve!(p, SCS.Optimizer(verbose=0))
 p.optval
 

diff --git a/docs/examples_literate/mixed_integer/aux_files/antidiag.jl b/docs/examples_literate/mixed_integer/aux_files/antidiag.jl
@@ -8,9 +8,8 @@
 # All expressions and atoms are subtpyes of AbstractExpr.
 # Please read expressions.jl first.
 #############################################################################
-
 import Convex.sign, Convex.monotonicity, Convex.curvature, Convex.evaluate, Convex.conic_form!
-export antidiag, sign, monotonicity, curvature, evaluate, conic_form!
+export antidiag
 
 ### Diagonal
 ### Represents the kth diagonal of an mxn matrix as a (min(m, n) - k) x 1 vector

diff --git a/docs/src/operations.md b/docs/src/operations.md
@@ -110,8 +110,8 @@ solver (including SCS and Mosek).
 | ------------------ | --------------------------------- | ------- | ------------- | ------------------------------ |
 | `nuclearnorm(x)`   | sum of singular values of $x$ | convex  | not monotonic | none                           |
 | `operatornorm(x)`  | max of singular values of $x$ | convex  | not monotonic | none                           |
-| `lambdamax(x)`     | max eigenvalue of $x$         | convex  | not monotonic | none                           |
-| `lambdamin(x)`     | min eigenvalue of $x$         | concave | not monotonic | none                           |
+| `eigmax(x)`     | max eigenvalue of $x$         | convex  | not monotonic | none                           |
+| `eigmin(x)`     | min eigenvalue of $x$         | concave | not monotonic | none                           |
 | `matrixfrac(x, P)` | $x^TP^{-1}x$                  | convex  | not monotonic | IC: P is positive semidefinite |
 
 Exponential + SDP representable Functions

diff --git a/src/Convex.jl b/src/Convex.jl
@@ -4,13 +4,36 @@ module Convex
 using OrderedCollections: OrderedDict
 using LinearAlgebra
 using SparseArrays
+using AbstractTrees: AbstractTrees
 
 using MathOptInterface
 const MOI = MathOptInterface
 const MOIU = MOI.Utilities
 const MOIB = MOI.Bridges
 
-global DEFAULT_SOLVER = nothing
+# Functions
+export conv, dotsort, entropy, exp, geomean, hinge_loss, huber, inner_product, invpos
+export log_perspective, logisticloss, logsumexp, matrixfrac, neg, norm2, norm_1, norm_inf, nuclearnorm
+export partialtrace, partialtranspose, pos, qol_elementwise, quadform, quadoverlin, rationalnorm
+export relative_entropy, scaledgeomean, sigmamax, square, sumlargest, sumlargesteigs, sumsmallest, sumsquares
+
+# rexports from LinearAlgebra
+export diag, diagm, Diagonal, dot, eigmax, eigmin, kron, logdet, norm, tr
+
+# Constraints
+export isposdef, ⪰, ⪯ # PSD constraints
+export socp
+
+# Variables
+export Constant, ComplexVariable, HermitianSemidefinite, Semidefinite, Variable
+export curvature, evaluate, fix!, free!, monotonicity, sign, vexity
+
+# Signs
+export Positive, Negative, ComplexSign, NoSign
+
+# Problems
+export add_constraint!, add_constraints!, maximize, minimize, Problem, satisfy, solve!
+
 ### modeling framework
 include("dcp.jl")
 include("expressions.jl")
@@ -71,7 +94,7 @@ include("atoms/second_order_cone/huber.jl")
 ### SDP atoms
 include("atoms/sdp_cone/nuclearnorm.jl")
 include("atoms/sdp_cone/operatornorm.jl")
-include("atoms/sdp_cone/lambda_min_max.jl")
+include("atoms/sdp_cone/eig_min_max.jl")
 include("atoms/sdp_cone/matrixfrac.jl")
 include("atoms/sdp_cone/sumlargesteigs.jl")
 
@@ -98,4 +121,7 @@ function clearmemory()
     Base.depwarn("Convex.clearmemory() is deprecated, as the memory leak it works around has been closed (in https://github.com/JuliaOpt/Convex.jl/pull/322). This function no longer does anything and will be removed in a future Convex.jl release.", :clearmemory )
 end
 
+@deprecate lambdamin eigmin
+@deprecate lambdamax eigmax
+
 end
diff --git a/src/atoms/affine/add_subtract.jl b/src/atoms/affine/add_subtract.jl
@@ -6,9 +6,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export +, -
-export sign, curvature, monotonicity, evaluate
-
 ### Unary Negation
 
 struct NegateAtom <: AbstractExpr

diff --git a/src/atoms/affine/conjugate.jl b/src/atoms/affine/conjugate.jl
@@ -1,6 +1,4 @@
 import Base.conj
-export conj
-export sign, curvature, monotonicity, evaluate, conic_form!
 struct ConjugateAtom <: AbstractExpr
     head::Symbol
     id_hash::UInt64

diff --git a/src/atoms/affine/conv.jl b/src/atoms/affine/conv.jl
@@ -3,8 +3,6 @@
 # Handles convolution between a constant vector and an expression vector.
 #############################################################################
 
-export conv
-
 function conv(x::Value, y::AbstractExpr)
     if (size(x,2) != 1 && length(size(x)) != 1) || size(y,2) != 1
         error("convolution only supported between two vectors")

diff --git a/src/atoms/affine/diag.jl b/src/atoms/affine/diag.jl
@@ -7,8 +7,6 @@
 
 # k >= min(num_cols, num_rows) || k <= -min(num_rows, num_cols)
 import LinearAlgebra.diag
-export diag
-#export sign, curvature, monotonicity, evaluate
 
 ### Diagonal
 ### Represents the kth diagonal of an mxn matrix as a (min(m, n) - k) x 1 vector

diff --git a/src/atoms/affine/diagm.jl b/src/atoms/affine/diagm.jl
@@ -6,7 +6,6 @@
 #############################################################################
 
 import LinearAlgebra.diagm, LinearAlgebra.Diagonal
-export diagm, Diagonal
 
 struct DiagMatrixAtom <: AbstractExpr
     head::Symbol

diff --git a/src/atoms/affine/dot.jl b/src/atoms/affine/dot.jl
@@ -1,5 +1,4 @@
 import LinearAlgebra.dot
-export dot
 
 ismatrix(x::AbstractExpr) = (s = size(x); length(s) == 2 && s[1] > 1 && s[2] > 1)
 ismatrix(::AbstractMatrix) = true

diff --git a/src/atoms/affine/index.jl b/src/atoms/affine/index.jl
@@ -1,5 +1,4 @@
-import Base: getindex, to_index
-export IndexAtom, getindex
+import Base.getindex
 
 const ArrayOrNothing = Union{AbstractArray, Nothing}
 

diff --git a/src/atoms/affine/inner_product.jl b/src/atoms/affine/inner_product.jl
@@ -1,5 +1,3 @@
-export inner_product
-
 function inner_product(x::AbstractExpr, y::AbstractExpr)
     if x.size == y.size && x.size[1] == x.size[2]
         return real(tr(x'*y))

diff --git a/src/atoms/affine/kron.jl b/src/atoms/affine/kron.jl
@@ -1,5 +1,4 @@
 import LinearAlgebra.kron
-export kron
 
 function kron(a::Value, b::AbstractExpr)
     rows = AbstractExpr[]

diff --git a/src/atoms/affine/multiply_divide.jl b/src/atoms/affine/multiply_divide.jl
@@ -7,7 +7,6 @@
 #############################################################################
 
 import Base.Broadcast.broadcasted
-export sign, monotonicity, curvature, evaluate, conic_form!
 
 ### Scalar and matrix multiplication
 

diff --git a/src/atoms/affine/partialtrace.jl b/src/atoms/affine/partialtrace.jl
@@ -1,4 +1,3 @@
-export partialtrace
 
 # We compute the partial trace of x by summing over
 # (I ⊗ <j| ⊗ I) x (I ⊗ |j> ⊗ I) for all j's
@@ -40,4 +39,4 @@ function partialtrace(x, sys::Int, dims::Vector)
     end
 
     return sum(j -> _term(x, j, sys, dims), 1:dims[sys])
-end
+end
diff --git a/src/atoms/affine/partialtranspose.jl b/src/atoms/affine/partialtranspose.jl
@@ -1,6 +1,4 @@
 import Base.sign
-export partialtranspose, PartialTransposeAtom
-export sign, curvature, monotonicity, evaluate, conic_form!
 
 struct PartialTransposeAtom <: AbstractExpr
     head::Symbol

diff --git a/src/atoms/affine/real_imag.jl b/src/atoms/affine/real_imag.jl
@@ -5,9 +5,6 @@
 #############################################################################
 
 import Base.real, Base.imag
-export real, imag
-export sign, monotonicity, curvature, evaluate
-
 
 ### Real
 struct RealAtom <: AbstractExpr

diff --git a/src/atoms/affine/reshape.jl b/src/atoms/affine/reshape.jl
@@ -1,7 +1,4 @@
 import Base.reshape, Base.vec
-export reshape, vec
-export sign, curvature, monotonicity, evaluate, conic_form!
-
 
 struct ReshapeAtom <: AbstractExpr
     head::Symbol

diff --git a/src/atoms/affine/stack.jl b/src/atoms/affine/stack.jl
@@ -1,7 +1,4 @@
 import Base.vcat, Base.hcat, Base.hvcat
-export vcat, hcat, hvcat, HcatAtom
-export sign, curvature, monotonicity, evaluate, conic_form!
-
 struct HcatAtom <: AbstractExpr
     head::Symbol
     id_hash::UInt64

diff --git a/src/atoms/affine/sum.jl b/src/atoms/affine/sum.jl
@@ -4,9 +4,7 @@
 # All expressions and atoms are subtpyes of AbstractExpr.
 # Please read expressions.jl first.
 #############################################################################
-
 import Base.sum
-export sum
 
 ### Sum Atom
 struct SumAtom <: AbstractExpr

diff --git a/src/atoms/affine/trace.jl b/src/atoms/affine/trace.jl
@@ -1,5 +1,4 @@
 import LinearAlgebra.tr
-export tr
 
 function tr(e::AbstractExpr)
     return sum(diag(e))

diff --git a/src/atoms/affine/transpose.jl b/src/atoms/affine/transpose.jl
@@ -6,8 +6,6 @@
 #############################################################################
 
 import Base.transpose, Base.adjoint
-export transpose, adjoint, TransposeAtom, AdjointAtom
-export sign, curvature, monotonicity, evaluate, conic_form!
 
 struct TransposeAtom <: AbstractExpr
     head::Symbol

diff --git a/src/atoms/exp_+_sdp_cone/logdet.jl b/src/atoms/exp_+_sdp_cone/logdet.jl
@@ -1,5 +1,4 @@
 import LinearAlgebra.logdet
-export logdet
 
 struct LogDetAtom <: AbstractExpr
     head::Symbol

diff --git a/src/atoms/exp_cone/entropy.jl b/src/atoms/exp_cone/entropy.jl
@@ -5,9 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export entropy
-export sign, curvature, monotonicity, evaluate
-
 ### Entropy: sum_i -x_i log (x_i)
 
 # TODO: make this work for a *list* of inputs, rather than just for scalar/vector/matrix inputs

diff --git a/src/atoms/exp_cone/exp.jl b/src/atoms/exp_cone/exp.jl
@@ -4,10 +4,7 @@
 # All expressions and atoms are subtpyes of AbstractExpr.
 # Please read expressions.jl first.
 #############################################################################
-
 import Base.exp
-export exp
-export sign, curvature, monotonicity, evaluate
 
 ### Exponential
 

diff --git a/src/atoms/exp_cone/log.jl b/src/atoms/exp_cone/log.jl
@@ -4,10 +4,7 @@
 # All expressions and atoms are subtpyes of AbstractExpr.
 # Please read expressions.jl first.
 #############################################################################
-
 import Base.log
-export log
-export sign, curvature, monotonicity, evaluate
 
 ### Logarithm
 

diff --git a/src/atoms/exp_cone/logsumexp.jl b/src/atoms/exp_cone/logsumexp.jl
@@ -5,9 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export logsumexp, logisticloss
-export sign, curvature, monotonicity, evaluate
-
 ### LogSumExp
 
 # TODO: make this work for a *list* of inputs, rather than just for vector/matrix inputs

diff --git a/src/atoms/exp_cone/relative_entropy.jl b/src/atoms/exp_cone/relative_entropy.jl
@@ -5,9 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export relative_entropy, log_perspective
-export sign, curvature, monotonicity, evaluate
-
 # TODO: make this work for a *list* of inputs, rather than just for scalar/vector/matrix inputs
 
 struct RelativeEntropyAtom <: AbstractExpr

diff --git a/src/atoms/lp_cone/abs.jl b/src/atoms/lp_cone/abs.jl
@@ -4,10 +4,7 @@
 # All expressions and atoms are subtpyes of AbstractExpr.
 # Please read expressions.jl first.
 #############################################################################
-
 import Base.abs, Base.abs2
-export abs, abs2
-export sign, curvature, monotonicity, evaluate
 
 ### Absolute Value
 

diff --git a/src/atoms/lp_cone/dotsort.jl b/src/atoms/lp_cone/dotsort.jl
@@ -5,9 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export dotsort
-export sign, curvature, monotonicity, evaluate
-
 # This atom computes dot(sort(x), sort(w)), where w is constant
 # for example, if w = [1 1 1 0 0 0 ... 0], it computes the sum of the 3 largest elements of x
 struct DotSortAtom <: AbstractExpr

diff --git a/src/atoms/lp_cone/max.jl b/src/atoms/lp_cone/max.jl
@@ -5,7 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 import Base.max
-export max, pos, hinge_loss
 
 # TODO: This can easily be extended to work
 ### Max Atom

diff --git a/src/atoms/lp_cone/maximum.jl b/src/atoms/lp_cone/maximum.jl
@@ -5,7 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 import Base.maximum
-export maximum
 
 ### Maximum Atom
 struct MaximumAtom <: AbstractExpr

diff --git a/src/atoms/lp_cone/min.jl b/src/atoms/lp_cone/min.jl
@@ -5,7 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 import Base.min
-export min, neg
 
 # TODO: This can easily be extended to work
 ### Min Atom

diff --git a/src/atoms/lp_cone/minimum.jl b/src/atoms/lp_cone/minimum.jl
@@ -5,7 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 import Base.minimum
-export minimum
 
 ### Minimum Atom
 struct MinimumAtom <: AbstractExpr

diff --git a/src/atoms/lp_cone/sumlargest.jl b/src/atoms/lp_cone/sumlargest.jl
@@ -5,9 +5,6 @@
 # Please read expressions.jl first.
 #############################################################################
 
-export sumlargest, sumsmallest
-export sign, curvature, monotonicity, evaluate
-
 struct SumLargestAtom <: AbstractExpr
     head::Symbol
     id_hash::UInt64