From e8bd7e417bd868341edf487f108fbf57d24247a1 Mon Sep 17 00:00:00 2001 From: Balasubramanian Narasimhan Date: Thu, 7 Nov 2019 11:48:05 -0800 Subject: [PATCH] Updated URLs and regenerated docs for website --- NEWS.md | 6 ++ docs/articles/cvxr_intro.html | 22 ++++---- docs/news/index.html | 12 ++++ docs/pkgdown.yml | 3 +- docs/reference/Abs-class.html | 20 +++---- docs/reference/AddExpression-class.html | 4 +- docs/reference/AffAtom-class.html | 14 ++--- docs/reference/AffineProd-class.html | 26 ++++----- docs/reference/Atom-class.html | 34 +++++------ docs/reference/AxisAtom-class.html | 8 +-- docs/reference/BinaryOperator-class.html | 8 +-- docs/reference/Bool-class.html | 10 ++-- docs/reference/BoolConstr-class.html | 4 +- docs/reference/CallbackParam-class.html | 12 ++-- docs/reference/Canonical-class.html | 16 +++--- docs/reference/Constant-class.html | 26 ++++----- docs/reference/Conv-class.html | 22 ++++---- docs/reference/CumSum-class.html | 12 ++-- docs/reference/DiagMat-class.html | 10 ++-- docs/reference/DiagVec-class.html | 10 ++-- docs/reference/DivExpression-class.html | 2 +- docs/reference/ECOS-class.html | 20 +++---- docs/reference/ECOS-status_map.html | 2 +- docs/reference/ECOS_BB-class.html | 16 +++--- docs/reference/Elementwise-class.html | 4 +- docs/reference/Entr-class.html | 18 +++--- docs/reference/EqConstraint-class.html | 16 +++--- docs/reference/Exp-class.html | 18 +++--- docs/reference/ExpCone-class.html | 8 +-- docs/reference/Expression-class.html | 38 ++++++------- docs/reference/GLPK-class.html | 18 +++--- docs/reference/GLPK-status_map.html | 2 +- docs/reference/GUROBI-class.html | 16 +++--- docs/reference/GUROBI-status_map.html | 2 +- docs/reference/GeoMean-class.html | 24 ++++---- docs/reference/HStack-class.html | 12 ++-- docs/reference/Huber-class.html | 22 ++++---- docs/reference/Index-class.html | 4 +- docs/reference/Int-class.html | 12 ++-- docs/reference/KLDiv-class.html | 22 ++++---- docs/reference/Kron-class.html | 22 ++++---- docs/reference/LPSOLVE-class.html | 18 +++--- docs/reference/LPSOLVE-status_map.html | 2 +- docs/reference/LambdaMax-class.html | 22 ++++---- docs/reference/Leaf-class.html | 24 ++++---- docs/reference/LeqConstraint-class.html | 22 ++++---- docs/reference/Log-class.html | 18 +++--- docs/reference/Log1p-class.html | 10 ++-- docs/reference/LogDet-class.html | 22 ++++---- docs/reference/LogSumExp-class.html | 18 +++--- docs/reference/Logistic-class.html | 20 +++---- docs/reference/MOSEK-class.html | 16 +++--- docs/reference/MOSEK-status_map.html | 2 +- docs/reference/MatrixFrac-class.html | 28 +++++----- docs/reference/MaxElemwise-class.html | 28 +++++----- docs/reference/MaxEntries-class.html | 20 +++---- docs/reference/Maximize-class.html | 20 +++---- docs/reference/Minimize-class.html | 22 ++++---- docs/reference/MulElemwise-class.html | 24 ++++---- docs/reference/MulExpression-class.html | 6 +- docs/reference/NegExpression-class.html | 2 +- docs/reference/NonNegative-class.html | 10 ++-- docs/reference/NonlinearConstraint-class.html | 2 +- docs/reference/NormNuc-class.html | 20 +++---- docs/reference/Objective-arith.html | 6 +- docs/reference/PSDConstraint-class.html | 16 +++--- docs/reference/Parameter-class.html | 22 ++++---- docs/reference/Pnorm-class.html | 26 ++++----- docs/reference/Power-class.html | 26 ++++----- docs/reference/Problem-arith.html | 6 +- docs/reference/Problem-class.html | 56 +++++++++---------- docs/reference/QuadOverLin-class.html | 28 +++++----- docs/reference/RMulExpression-class.html | 8 +-- docs/reference/Rdictdefault-class.html | 6 +- docs/reference/Reshape-class.html | 14 ++--- docs/reference/SCS-class.html | 20 +++---- docs/reference/SCS-status_map.html | 2 +- docs/reference/SDP-class.html | 4 +- docs/reference/SOC-class.html | 4 +- docs/reference/SOCAxis-class.html | 8 +-- docs/reference/Semidef.html | 2 +- docs/reference/SemidefUpperTri-class.html | 10 ++-- docs/reference/SigmaMax-class.html | 20 +++---- docs/reference/SizeMetrics-class.html | 2 +- docs/reference/Solver-capable.html | 4 +- docs/reference/Solver-choose_solver.html | 2 +- docs/reference/Solver-class.html | 6 +- docs/reference/Solver-solve.html | 2 +- docs/reference/SolverStats-class.html | 2 +- docs/reference/Sqrt-class.html | 24 ++++---- docs/reference/Square-class.html | 24 ++++---- docs/reference/SumEntries-class.html | 8 +-- docs/reference/SumLargest-class.html | 24 ++++---- docs/reference/Symmetric.html | 2 +- docs/reference/SymmetricUpperTri-class.html | 4 +- docs/reference/Trace-class.html | 12 ++-- docs/reference/Transpose-class.html | 6 +- docs/reference/UnaryOperator-class.html | 2 +- docs/reference/UpperTri-class.html | 12 ++-- docs/reference/VStack-class.html | 12 ++-- docs/reference/Variable-class.html | 32 +++++------ docs/reference/abs.html | 12 ++-- docs/reference/affine_prod.html | 6 +- docs/reference/bmat.html | 10 ++-- docs/reference/canonicalize.html | 2 +- docs/reference/cone-methods.html | 2 +- docs/reference/conv.html | 12 ++-- docs/reference/cumsum_axis.html | 16 +++--- docs/reference/curvature-atom.html | 8 +-- docs/reference/curvature-comp.html | 6 +- docs/reference/curvature-methods.html | 12 ++-- docs/reference/curvature.html | 8 +-- docs/reference/cvxr_norm.html | 6 +- docs/reference/diag.html | 16 +++--- docs/reference/diff.html | 24 ++++---- docs/reference/domain.html | 30 +++++----- docs/reference/dspop.html | 2 +- docs/reference/dssamp.html | 4 +- docs/reference/entr.html | 12 ++-- docs/reference/exp.html | 14 ++--- docs/reference/expression-parts.html | 12 ++-- docs/reference/format_constr.html | 2 +- docs/reference/format_results.html | 2 +- docs/reference/geo_mean.html | 16 +++--- docs/reference/get_data.html | 2 +- docs/reference/get_problem_data.html | 12 ++-- docs/reference/grad.html | 18 +++--- docs/reference/graph_implementation.html | 2 +- docs/reference/harmonic_mean.html | 10 ++-- docs/reference/hstack.html | 32 +++++------ docs/reference/huber.html | 12 ++-- docs/reference/id.html | 6 +- docs/reference/import_solver.html | 4 +- docs/reference/inv_pos.html | 10 ++-- docs/reference/is_dcp.html | 20 +++---- docs/reference/is_qp.html | 2 +- docs/reference/kl_div.html | 18 +++--- docs/reference/kronecker.html | 16 +++--- docs/reference/lambda_max.html | 16 +++--- docs/reference/lambda_min.html | 10 ++-- docs/reference/lambda_sum_largest.html | 10 ++-- docs/reference/lambda_sum_smallest.html | 10 ++-- docs/reference/log.html | 48 ++++++++-------- docs/reference/log_det.html | 18 +++--- docs/reference/log_sum_exp.html | 10 ++-- docs/reference/logistic.html | 16 +++--- docs/reference/matrix_frac.html | 20 +++---- docs/reference/matrix_trace.html | 10 ++-- docs/reference/max_elemwise.html | 12 ++-- docs/reference/max_entries.html | 20 +++---- docs/reference/mean.html | 12 ++-- docs/reference/min_elemwise.html | 12 ++-- docs/reference/min_entries.html | 14 ++--- docs/reference/mixed_norm.html | 14 ++--- docs/reference/mul_elemwise.html | 16 +++--- docs/reference/name.html | 12 ++-- docs/reference/neg.html | 10 ++-- docs/reference/norm.html | 16 +++--- docs/reference/norm1.html | 22 ++++---- docs/reference/norm2.html | 26 ++++----- docs/reference/norm_inf.html | 30 +++++----- docs/reference/norm_nuc.html | 10 ++-- docs/reference/p_norm.html | 22 ++++---- docs/reference/pos.html | 12 ++-- docs/reference/power.html | 12 ++-- docs/reference/problem-parts.html | 2 +- docs/reference/psolve.html | 14 ++--- docs/reference/quad_form.html | 18 +++--- docs/reference/quad_over_lin.html | 14 ++--- docs/reference/reshape_expr.html | 42 +++++++------- docs/reference/residual-methods.html | 4 +- docs/reference/scalene.html | 10 ++-- docs/reference/sigma_max.html | 10 ++-- docs/reference/sign-methods.html | 10 ++-- docs/reference/sign.html | 2 +- docs/reference/sign_from_args.html | 2 +- docs/reference/size-methods.html | 8 +-- docs/reference/size.html | 8 +-- docs/reference/size_from_args.html | 2 +- docs/reference/sqrt.html | 6 +- docs/reference/square.html | 14 ++--- docs/reference/sum_entries.html | 20 +++---- docs/reference/sum_largest.html | 10 ++-- docs/reference/sum_smallest.html | 10 ++-- docs/reference/sum_squares.html | 12 ++-- docs/reference/to_numeric.html | 2 +- docs/reference/transpose.html | 12 ++-- docs/reference/tv.html | 14 ++--- docs/reference/unpack_results.html | 22 ++++---- docs/reference/upper_tri.html | 10 ++-- docs/reference/validate_args.html | 2 +- docs/reference/validate_solver.html | 2 +- docs/reference/validate_val.html | 4 +- docs/reference/value-methods.html | 4 +- docs/reference/vec.html | 12 ++-- docs/reference/vstack.html | 30 +++++----- 196 files changed, 1302 insertions(+), 1285 deletions(-) diff --git a/NEWS.md b/NEWS.md index 57309fc7..18c65996 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# CVXR 0.99-7 + +* Update CVXR to require version 0.5.3 of ECOSolveR +* Update CVXR to require version 1.3-1 of scs +* Fix URLs to point to [cvxgrp addresses](https://www.cvxgrp.org) + # CVXR 0.99-6 * Mosek Glue modifications for MOSEK 8+, [issue 49](https://github.com/anqif/CVXR/issues/49). diff --git a/docs/articles/cvxr_intro.html b/docs/articles/cvxr_intro.html index ecab078d..1cab9417 100644 --- a/docs/articles/cvxr_intro.html +++ b/docs/articles/cvxr_intro.html @@ -78,7 +78,7 @@

Disciplined Convex Optimization in R

Anqi Fu, Balasubramanian Narasimhan and Stephen Boyd

-

2019-11-06

+

2019-11-07

@@ -185,20 +185,20 @@

- + -
objective <- Minimize(sum((Y - X %*% betaHat)^2))
-

Notice how the objective is specified using functions such as sum, *%* and ^, that are familiar to R users despite that fact that betaHat is no ordinary R expression but a CVXR expression.

+
objective <- Minimize(sum((Y - X %*% betaHat)^2))
+

Notice how the objective is specified using functions such as sum, *%* and ^, that are familiar to R users despite that fact that betaHat is no ordinary R expression but a CVXR expression.

- + - + @@ -274,8 +274,8 @@

On the surface, it appears that we have replaced one call to lm with at least five or six lines of new R code. On top of that, the code actually runs slower, and so it is not clear what was really achieved.

So suppose we knew for a fact that the \(\beta\)s were nonnegative and we wish to take this fact into account. This is nonnegative least squares regression and lm would no longer do the job.

In CVXR, the modified problem merely requires the addition of a constraint to the problem definition.

-
problem <- Problem(objective, constraints = list(betaHat >= 0))
-result <- solve(problem)
+
problem <- Problem(objective, constraints = list(betaHat >= 0))
+result <- solve(problem)
 m <- data.frame(CVXR.est = result$getValue(betaHat))
 rownames(m) <- paste0("$\\beta_{", 1:p, "}$")
 knitr::kable(m)

@@ -442,7 +442,7 @@ 

 
 
but it is easier working with matrices in general with CVXR.

 
For the positivity for rest of the variables, we construct a \(10\times 10\) matrix \(A\) to have 1’s along the diagonal everywhere except rows 2 and 3 and zeros everywhere.

-
B <- diag(c(1, 0, 0, rep(1, 7)))
+
B <- diag(c(1, 0, 0, rep(1, 7)))
 colnames(B) <- rownames(B) <- paste0("$\\beta_{", 1:p, "}$")
     knitr::kable(B)

 
@@ -598,8 +598,8 @@ 

 
which we express in R as

 
 
Now we are ready to solve the problem just as before.

-
problem <- Problem(objective, constraints = list(constraint1, constraint2))
-result <- solve(problem)

+
problem <- Problem(objective, constraints = list(constraint1, constraint2))
+result <- solve(problem)

 
And we can get the estimates of \(\beta\).

 
m <- data.frame(CVXR.soln = result$getValue(betaHat))
 rownames(m) <- paste0("$\\beta_{", 1:p, "}$")
diff --git a/docs/news/index.html b/docs/news/index.html
index ba52b2ad..3a6b5fbf 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -117,6 +117,17 @@ 
Changelog 

       
     

 
+    

+

+CVXR 0.99-7 2019-11-07 
+

+
    
+
  • Update CVXR to require version 0.5.3 of ECOSolveR
    • 
+
  • Update CVXR to require version 1.3-1 of scs
    • 
+
  • Fix URLs to point to cvxgrp addresses
+
    • 
+

+

     

 

 CVXR 0.99-6 2019-06-02 
@@ -257,6 +268,7 @@ 

     

       
Contents

       
    
+        
  • 0.99-7
    • 
         
  • 0.99-6
    • 
         
  • 0.99-5
    • 
         
  • 0.99-4
    • 
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index f50e3943..00fcabc6 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,6 +1,5 @@
 pandoc: 2.2.3.2
 pkgdown: 1.4.1
 pkgdown_sha: ~
-articles:
-  cvxr_intro: cvxr_intro.html
+articles: []
 
diff --git a/docs/reference/Abs-class.html b/docs/reference/Abs-class.html
index e1ba2715..51901146 100644
--- a/docs/reference/Abs-class.html
+++ b/docs/reference/Abs-class.html
@@ -127,28 +127,28 @@ 
    The Abs class.
    
     
    Abs(x)
 
 # S4 method for Abs
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for Abs
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for Abs
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for Abs
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for Abs
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for Abs
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for Abs
-is_pwl(object)
+is_pwl(object)
 
 # S4 method for Abs
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)
    
 
     
    Arguments
    
@@ -156,7 +156,7 @@ 
    Arg
     

-      
+      
@@ -202,7 +202,7 @@ 
Slots

     
 
 

-
x
An Expression object.

+
x
An Expression object.

 
 

 
diff --git a/docs/reference/AddExpression-class.html b/docs/reference/AddExpression-class.html
index 811c30cc..5ef795d3 100644
--- a/docs/reference/AddExpression-class.html
+++ b/docs/reference/AddExpression-class.html
@@ -151,7 +151,7 @@ 
Arg
     

-      
+      
@@ -188,7 +188,7 @@ 
Slots

     
 
 

-
arg_groups
A list of Expressions and numeric data.frame, matrix, or vector objects.

+
arg_groups
A list of Expressions and numeric data.frame, matrix, or vector objects.

 
 

 
diff --git a/docs/reference/AffAtom-class.html b/docs/reference/AffAtom-class.html
index 06e1dae3..deeae00a 100644
--- a/docs/reference/AffAtom-class.html
+++ b/docs/reference/AffAtom-class.html
@@ -125,25 +125,25 @@ 
The AffAtom class.

     
 
     
# S4 method for AffAtom
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for AffAtom
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for AffAtom
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for AffAtom
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for AffAtom
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for AffAtom
-is_quadratic(object)
+is_quadratic(object)
 
 # S4 method for AffAtom
-is_pwl(object)

+is_pwl(object)
 
     
Arguments

     

     

       x
An Expression object.
An Expression object.

     

     

       object

     

       e1, e2
The Expression objects or numeric constants to add.
The Expression objects or numeric constants to add.

     

     

       object

diff --git a/docs/reference/AffineProd-class.html b/docs/reference/AffineProd-class.html
index 3eca34e6..8b71a413 100644
--- a/docs/reference/AffineProd-class.html
+++ b/docs/reference/AffineProd-class.html
@@ -127,42 +127,42 @@ 
The AffineProd class.

     
AffineProd(x, y)
 
 # S4 method for AffineProd
-validate_args(object)
+validate_args(object)
 
 # S4 method for AffineProd
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for AffineProd
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for AffineProd
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for AffineProd
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for AffineProd
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for AffineProd
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for AffineProd
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for AffineProd
-is_quadratic(object)

+is_quadratic(object)
 
     
Arguments

     

-      
+      
-      
+      
@@ -197,9 +197,9 @@ 
Slots

     
 
 

-
x
An Expression or numeric constant representing the left-hand value.

+
x
An Expression or numeric constant representing the left-hand value.

 
-
y
An Expression or numeric constant representing the right-hand value.

+
y
An Expression or numeric constant representing the right-hand value.

 
 

 
diff --git a/docs/reference/Atom-class.html b/docs/reference/Atom-class.html
index d97a6463..95e61fa2 100644
--- a/docs/reference/Atom-class.html
+++ b/docs/reference/Atom-class.html
@@ -125,10 +125,10 @@ 
The Atom class.

     
 
     
# S4 method for Atom
-validate_args(object)
+validate_args(object)
 
 # S4 method for Atom
-size(object)
+size(object)
 
 # S4 method for Atom
 dim(x)
@@ -140,41 +140,41 @@ 
The Atom class.

 ncol(x)
 
 # S4 method for Atom
-is_positive(object)
+is_positive(object)
 
 # S4 method for Atom
-is_negative(object)
+is_negative(object)
 
 # S4 method for Atom
-is_convex(object)
+is_convex(object)
 
 # S4 method for Atom
-is_concave(object)
+is_concave(object)
 
 # S4 method for Atom
-canonicalize(object)
+canonicalize(object)
 
 # S4 method for Atom
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)
 
 # S4 method for Atom
-variables(object)
+variables(object)
 
 # S4 method for Atom
-parameters(object)
+parameters(object)
 
 # S4 method for Atom
-constants(object)
+constants(object)
 
 # S4 method for Atom
-value(object)
+value(object)
 
 # S4 method for Atom
-grad(object)
+grad(object)
 
 # S4 method for Atom
-domain(object)

+domain(object)
 
     
Arguments

     

     
     

       x
An Expression or numeric constant representing the left-hand value.
An Expression or numeric constant representing the left-hand value.

     

     

       y
An Expression or numeric constant representing the right-hand value.
An Expression or numeric constant representing the right-hand value.

     

     

       object

@@ -212,9 +212,9 @@ 
# S4 method for AxisAtom
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for AxisAtom
-get_data(object)
+get_data(object)
 
 # S4 method for AxisAtom
-validate_args(object)
+validate_args(object)
 
     
Arguments

     

-      
+      

     
     

       object
An Atom object.
An Atom object.

     

     

 
diff --git a/docs/reference/BinaryOperator-class.html b/docs/reference/BinaryOperator-class.html
index 8f7ff927..7d63aa39 100644
--- a/docs/reference/BinaryOperator-class.html
+++ b/docs/reference/BinaryOperator-class.html
@@ -125,10 +125,10 @@ 
The BinaryOperator class.

     

 
     
# S4 method for BinaryOperator
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for BinaryOperator
-sign_from_args(object)

+sign_from_args(object)

Arguments

@@ -155,9 +155,9 @@

Slots

-
lh_exp

The Expression on the left-hand side of the operator.

+
lh_exp

The Expression on the left-hand side of the operator.

-
rh_exp

The Expression on the right-hand side of the operator.

+
rh_exp

The Expression on the right-hand side of the operator.

op_name

A character string indicating the binary operation.

diff --git a/docs/reference/Bool-class.html b/docs/reference/Bool-class.html index fc37fadd..7a6bc1f9 100644 --- a/docs/reference/Bool-class.html +++ b/docs/reference/Bool-class.html @@ -130,13 +130,13 @@

The Bool class.

as.character(x) # S4 method for Bool -canonicalize(object) +canonicalize(object) # S4 method for Bool -is_positive(object) +is_positive(object) # S4 method for Bool -is_negative(object) +is_negative(object)

Arguments

@@ -187,7 +187,7 @@

Slots

Examples

x <- Bool(3, name = "indicator") ## Boolean 3-vector
 y <- Bool(3, 3) ## Matrix boolean
-name(x)
#> [1] "indicator"
as.character(x)
#> [1] "Bool(3, 1)"
canonicalize(y)
#> [[1]]
+name(x)
#> [1] "indicator"
as.character(x)
#> [1] "Bool(3, 1)"
canonicalize(y)
#> [[1]]
 #> [[1]]$type
 #> [1] "variable"
 #> 
@@ -245,7 +245,7 @@ 
Examp
 #> [1] 4
 #> 
 #> 
-#> 
is_positive(x)
#> [1] TRUE
is_negative(y)
#> [1] FALSE
+#>
is_positive(x)
#> [1] TRUE
is_negative(y)
#> [1] FALSE
diff --git a/docs/reference/CallbackParam-class.html b/docs/reference/CallbackParam-class.html index 1bcb7fa5..a95a09f6 100644 --- a/docs/reference/CallbackParam-class.html +++ b/docs/reference/CallbackParam-class.html @@ -128,10 +128,10 @@

The CallbackParam class.

sign=UNKNOWN) # S4 method for CallbackParam -value(object) +value(object) # S4 method for CallbackParam -get_data(object) +get_data(object)

Arguments

@@ -178,10 +178,10 @@

Slots

Examples

- 
x <- Variable(2)
-dim <- size(x)
-y <- CallbackParam(value(x), dim[1], dim[2], sign = "POSITIVE")
-get_data(y)
#> $callback
+    
x <- Variable(2)
+dim <- size(x)
+y <- CallbackParam(value(x), dim[1], dim[2], sign = "POSITIVE")
+get_data(y)
#> $callback
 #> [1] NA
 #> 
 #> $rows
diff --git a/docs/reference/Canonical-class.html b/docs/reference/Canonical-class.html
index 70a3a7a4..f0ee4fbe 100644
--- a/docs/reference/Canonical-class.html
+++ b/docs/reference/Canonical-class.html
@@ -125,19 +125,19 @@ 
The Canonical class.

     

 
     
# S4 method for Canonical
-canonicalize(object)
+canonicalize(object)
 
 # S4 method for Canonical
-variables(object)
+variables(object)
 
 # S4 method for Canonical
-parameters(object)
+parameters(object)
 
 # S4 method for Canonical
-constants(object)
+constants(object)
 
 # S4 method for Canonical
-get_data(object)

+get_data(object)

 
     
Arguments
@@ -153,9 +153,9 @@

Arg

- +
expr

An Expression, numeric element, vector, matrix, or data.frame.

An Expression, numeric element, vector, matrix, or data.frame.
@@ -211,16 +211,16 @@

Slots

Examples

x <- Constant(5)
-y <- Constant(diag(3))
-get_data(y)
#> [[1]]
+y <- Constant(diag(3))
+get_data(y)
#> [[1]]
 #>      [,1] [,2] [,3]
 #> [1,]    1    0    0
 #> [2,]    0    1    0
 #> [3,]    0    0    1
-#> 
value(y)
#>      [,1] [,2] [,3]
+#> 
value(y)
#>      [,1] [,2] [,3]
 #> [1,]    1    0    0
 #> [2,]    0    1    0
-#> [3,]    0    0    1
is_positive(y)
#> [1] TRUE
size(y)
#> [1] 3 3
as.Constant(y)
#> Constant(CONSTANT, POSITIVE, (3,3))
+#> [3,] 0 0 1
is_positive(y)
#> [1] TRUE
size(y)
#> [1] 3 3
as.Constant(y)
#> Constant(CONSTANT, POSITIVE, (3,3))
# S4 method for Solver
-validate_solver(solver, constraints)
+validate_solver(solver, constraints)
 
 # S4 method for Solver
 nonlin_constr(solver)
 
 # S4 method for Solver
-Solver.solve(solver, objective, constraints,
+Solver.solve(solver, objective, constraints,
   cached_data, warm_start, verbose, ...)
 
 # S4 method for Solver
-format_results(solver, results_dict, data, cached_data)
+format_results(solver, results_dict, data, cached_data)

Arguments

diff --git a/docs/reference/Solver-solve.html b/docs/reference/Solver-solve.html index cd7ec4a8..f9c16d9c 100644 --- a/docs/reference/Solver-solve.html +++ b/docs/reference/Solver-solve.html @@ -132,7 +132,7 @@

Arg

- + diff --git a/docs/reference/SolverStats-class.html b/docs/reference/SolverStats-class.html index ab14db67..4cfeaea6 100644 --- a/docs/reference/SolverStats-class.html +++ b/docs/reference/SolverStats-class.html @@ -121,7 +121,7 @@

The SolverStats class.

-

This class contains the miscellaneous information that is returned by a solver after solving, but that is not captured directly by the Problem object.

+

This class contains the miscellaneous information that is returned by a solver after solving, but that is not captured directly by the Problem object.

SolverStats(results_dict = list(), solver_name = NA_character_)
diff --git a/docs/reference/Sqrt-class.html b/docs/reference/Sqrt-class.html index c5ecf8b8..cff691a2 100644 --- a/docs/reference/Sqrt-class.html +++ b/docs/reference/Sqrt-class.html @@ -127,34 +127,34 @@

The Sqrt class.

Sqrt(x)
 
 # S4 method for Sqrt
-validate_args(object)
+validate_args(object)
 
 # S4 method for Sqrt
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for Sqrt
-get_data(object)
+get_data(object)
 
 # S4 method for Sqrt
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for Sqrt
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for Sqrt
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for Sqrt
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for Sqrt
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for Sqrt
-is_quadratic(object)
+is_quadratic(object)
 
 # S4 method for Sqrt
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -162,7 +162,7 @@

Arg

- + @@ -210,7 +210,7 @@

Slots

-
x

An Expression object.

+
x

An Expression object.

diff --git a/docs/reference/Square-class.html b/docs/reference/Square-class.html index fb4718a1..409e2d1d 100644 --- a/docs/reference/Square-class.html +++ b/docs/reference/Square-class.html @@ -127,34 +127,34 @@

The Square class.

Square(x)
 
 # S4 method for Square
-validate_args(object)
+validate_args(object)
 
 # S4 method for Square
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for Square
-get_data(object)
+get_data(object)
 
 # S4 method for Square
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for Square
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for Square
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for Square
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for Square
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for Square
-is_quadratic(object)
+is_quadratic(object)
 
 # S4 method for Square
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -162,7 +162,7 @@

Arg

- + @@ -210,7 +210,7 @@

Slots

-
x

An Expression object.

+
x

An Expression object.

diff --git a/docs/reference/SumEntries-class.html b/docs/reference/SumEntries-class.html index c8385f3e..b4a4f38b 100644 --- a/docs/reference/SumEntries-class.html +++ b/docs/reference/SumEntries-class.html @@ -127,10 +127,10 @@

The SumEntries class.

SumEntries(expr, axis = NA_real_)
 
 # S4 method for SumEntries
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for SumEntries
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -138,7 +138,7 @@

Arg

- + @@ -178,7 +178,7 @@

Slots

-
expr

An Expression representing a vector or matrix.

+
expr

An Expression representing a vector or matrix.

axis

(Optional) The dimension across which to apply the function: 1 indicates rows, 2 indicates columns, and NA indicates rows and columns. The default is NA.

diff --git a/docs/reference/SumLargest-class.html b/docs/reference/SumLargest-class.html index 7618d234..14b4f825 100644 --- a/docs/reference/SumLargest-class.html +++ b/docs/reference/SumLargest-class.html @@ -127,34 +127,34 @@

The SumLargest class.

SumLargest(x, k)
 
 # S4 method for SumLargest
-validate_args(object)
+validate_args(object)
 
 # S4 method for SumLargest
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for SumLargest
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for SumLargest
-sign_from_args(object)
+sign_from_args(object)
 
 # S4 method for SumLargest
-is_atom_convex(object)
+is_atom_convex(object)
 
 # S4 method for SumLargest
-is_atom_concave(object)
+is_atom_concave(object)
 
 # S4 method for SumLargest
-is_incr(object, idx)
+is_incr(object, idx)
 
 # S4 method for SumLargest
-is_decr(object, idx)
+is_decr(object, idx)
 
 # S4 method for SumLargest
-get_data(object)
+get_data(object)
 
 # S4 method for SumLargest
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -162,7 +162,7 @@

Arg

- + @@ -214,7 +214,7 @@

Slots

-
x

An Expression or numeric matrix.

+
x

An Expression or numeric matrix.

k

The number of largest values to sum over.

diff --git a/docs/reference/Symmetric.html b/docs/reference/Symmetric.html index 9cc770e4..44b53a08 100644 --- a/docs/reference/Symmetric.html +++ b/docs/reference/Symmetric.html @@ -141,7 +141,7 @@

Arg

Value

-

An Expression representing the symmetric matrix.

+

An Expression representing the symmetric matrix.

Examples

x <- Symmetric(3, name="s3")
diff --git a/docs/reference/SymmetricUpperTri-class.html b/docs/reference/SymmetricUpperTri-class.html index feeb5621..e6f96229 100644 --- a/docs/reference/SymmetricUpperTri-class.html +++ b/docs/reference/SymmetricUpperTri-class.html @@ -130,7 +130,7 @@

The SymmetricUpperTri class.

as.character(x) # S4 method for SymmetricUpperTri -get_data(object) +get_data(object)

Arguments

solver

A Solver object.

A Solver object.
objective
x

An Expression object.

An Expression object.
object
x

An Expression object.

An Expression object.
object
expr

An Expression representing a vector or matrix.

An Expression representing a vector or matrix.
axis
x

An Expression or numeric matrix.

An Expression or numeric matrix.
k
@@ -176,7 +176,7 @@

Slots

Examples

x <- SymmetricUpperTri(3, name="s3")
-name(x)
#> [1] "s3"
get_data(x)
#> [[1]]
+name(x)
#> [1] "s3"
get_data(x)
#> [[1]]
 #> [1] 3
 #> 
 #> [[2]]
diff --git a/docs/reference/Trace-class.html b/docs/reference/Trace-class.html
index 64346dea..1a79e0ea 100644
--- a/docs/reference/Trace-class.html
+++ b/docs/reference/Trace-class.html
@@ -127,16 +127,16 @@ 
The Trace class.

     
Trace(expr)
 
 # S4 method for Trace
-validate_args(object)
+validate_args(object)
 
 # S4 method for Trace
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for Trace
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for Trace
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

 
     
Arguments

@@ -144,7 +144,7 @@ 
Arg
- + @@ -182,7 +182,7 @@

Slots

-
expr

An Expression representing a matrix.

+
expr

An Expression representing a matrix.

diff --git a/docs/reference/Transpose-class.html b/docs/reference/Transpose-class.html index b4ca70b0..5befbd3a 100644 --- a/docs/reference/Transpose-class.html +++ b/docs/reference/Transpose-class.html @@ -125,13 +125,13 @@

The Transpose class.

# S4 method for Transpose
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for Transpose
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for Transpose
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

diff --git a/docs/reference/UnaryOperator-class.html b/docs/reference/UnaryOperator-class.html index 0f65d57b..e57257a8 100644 --- a/docs/reference/UnaryOperator-class.html +++ b/docs/reference/UnaryOperator-class.html @@ -131,7 +131,7 @@

Slots

-
expr

The Expression that is being operated upon.

+
expr

The Expression that is being operated upon.

op_name

A character string indicating the unary operation.

diff --git a/docs/reference/UpperTri-class.html b/docs/reference/UpperTri-class.html index 7d31fb13..9b057cd1 100644 --- a/docs/reference/UpperTri-class.html +++ b/docs/reference/UpperTri-class.html @@ -127,16 +127,16 @@

The UpperTri class.

UpperTri(expr)
 
 # S4 method for UpperTri
-validate_args(object)
+validate_args(object)
 
 # S4 method for UpperTri
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for UpperTri
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for UpperTri
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -144,7 +144,7 @@

Arg

- + @@ -182,7 +182,7 @@

Slots

-
expr

An Expression or numeric matrix.

+
expr

An Expression or numeric matrix.

diff --git a/docs/reference/VStack-class.html b/docs/reference/VStack-class.html index 42ef2dde..b7664ab6 100644 --- a/docs/reference/VStack-class.html +++ b/docs/reference/VStack-class.html @@ -127,16 +127,16 @@

The VStack class.

VStack(...)
 
 # S4 method for VStack
-validate_args(object)
+validate_args(object)
 
 # S4 method for VStack
-to_numeric(object, values)
+to_numeric(object, values)
 
 # S4 method for VStack
-size_from_args(object)
+size_from_args(object)
 
 # S4 method for VStack
-graph_implementation(object, arg_objs, size,
+graph_implementation(object, arg_objs, size,
   data = NA_real_)

Arguments

@@ -144,7 +144,7 @@

Arg

- + @@ -182,7 +182,7 @@

Slots

-
...

Expression objects or matrices. All arguments must have the same number of columns.

+
...

Expression objects or matrices. All arguments must have the same number of columns.

diff --git a/docs/reference/Variable-class.html b/docs/reference/Variable-class.html index 05938ea7..0b8ba0c5 100644 --- a/docs/reference/Variable-class.html +++ b/docs/reference/Variable-class.html @@ -130,37 +130,37 @@

The Variable class.

as.character(x) # S4 method for Variable -id(object) +id(object) # S4 method for Variable -is_positive(object) +is_positive(object) # S4 method for Variable -is_negative(object) +is_negative(object) # S4 method for Variable -size(object) +size(object) # S4 method for Variable -get_data(object) +get_data(object) # S4 method for Variable -name(object) +name(object) # S4 method for Variable -value(object) +value(object) # S4 method for Variable -value(object) <-value +value(object) <-value# S4 method for Variable -grad(object) +grad(object) # S4 method for Variable -variables(object) +variables(object) # S4 method for Variable -canonicalize(object) +canonicalize(object)

Arguments

expr

An Expression representing a matrix.

An Expression representing a matrix.
object
expr

An Expression or numeric matrix.

An Expression or numeric matrix.
object
...

Expression objects or matrices. All arguments must have the same number of columns.

Expression objects or matrices. All arguments must have the same number of columns.
object
@@ -223,11 +223,11 @@

Slots

Examples

x <- Variable(3, name = "x0") ## 3-int variable
 y <- Variable(3, 3, name = "y0") # Matrix variable
-as.character(y)
#> [1] "Variable(3, 3)"
id(y)
#> [1] 35
is_positive(x)
#> [1] FALSE
is_negative(x)
#> [1] FALSE
size(y)
#> [1] 3 3
name(y)
#> [1] "y0"
value(y) <- matrix(1:9, nrow = 3)
-value(y)
#>      [,1] [,2] [,3]
+as.character(y)
#> [1] "Variable(3, 3)"
id(y)
#> [1] 35
is_positive(x)
#> [1] FALSE
is_negative(x)
#> [1] FALSE
size(y)
#> [1] 3 3
name(y)
#> [1] "y0"
value(y) <- matrix(1:9, nrow = 3)
+value(y)
#>      [,1] [,2] [,3]
 #> [1,]    1    4    7
 #> [2,]    2    5    8
-#> [3,]    3    6    9
grad(y)
#> $`35`
+#> [3,]    3    6    9
grad(y)
#> $`35`
 #> 9 x 9 sparse Matrix of class "dgCMatrix"
 #>                        
 #>  [1,] 1 . . . . . . . .
@@ -239,8 +239,8 @@ 
Examp
 #>  [7,] . . . . . . 1 . .
 #>  [8,] . . . . . . . 1 .
 #>  [9,] . . . . . . . . 1
-#> 
variables(y)
#> [[1]]
-#> Variable(3, 3)
canonicalize(y)
#> [[1]]
+#> 
variables(y)
#> [[1]]
+#> Variable(3, 3)
canonicalize(y)
#> [[1]]
 #> [[1]]$type
 #> [1] "variable"
 #> 
diff --git a/docs/reference/abs.html b/docs/reference/abs.html
index e7dc8c6a..358e5452 100644
--- a/docs/reference/abs.html
+++ b/docs/reference/abs.html
@@ -125,25 +125,25 @@ 
Absolute Value

     

 
     
# S4 method for Expression
-abs(x)

+abs(x)

Arguments

- +
x

An Expression.

An Expression.

Value

-

An Expression representing the absolute value of the input.

+

An Expression representing the absolute value of the input.

Examples

- 
A <- Variable(2,2)
-prob <- Problem(Minimize(sum(abs(A))), list(A <= -2))
-result <- solve(prob)
+    
A <- Variable(2,2)
+prob <- Problem(Minimize(sum(abs(A))), list(A <= -2))
+result <- solve(prob)
 result$value
#> [1] 8
result$getValue(A)
#>      [,1] [,2]
 #> [1,]   -2   -2
 #> [2,]   -2   -2

diff --git a/docs/reference/affine_prod.html b/docs/reference/affine_prod.html
index 69337e6f..9dbf6182 100644
--- a/docs/reference/affine_prod.html
+++ b/docs/reference/affine_prod.html
@@ -131,17 +131,17 @@ 
Arg
     
     
       x
-      
An Expression or numeric constant representing the left-hand value.

+      
An Expression or numeric constant representing the left-hand value.

     
     
       y
-      
An Expression or numeric constant representing the right-hand value.

+      
An Expression or numeric constant representing the right-hand value.

     
     
 
     
Value

 
-    
An Expression representing the product of x and y.

+    
An Expression representing the product of x and y.