Reductions¶
A Reduction
is a transformation
from one problem to an equivalent problem. Two problems are equivalent
if a solution of one can be converted to a solution of the other with no
more than a moderate amount of effort. CVXPY uses reductions to rewrite
problems into forms that solvers will accept.
Disclaimer¶
The majority of users do not need to know anything about CVXPY’s reduction system. Indeed, most users need not even know that reductions exist!
In order to make sure that we have flexibility to improve CVXPY’s speed and capabilities while preserving backwards-compatibility, we have determined that the reduction system will not be considered part of CVXPY’s public API. As such, aspects of this system can change without notice in future releases.
We provide this documentation for CVXPY contributors, for the curious, and for those who are okay with building on an API that may not be available in future versions of CVXPY. Please contact us if you have an interesting application which requires direct access to the Reduction system and if you care about forward compatibility with future versions of CVXPY.
Types of Reductions¶
Reductions allow CVXPY to support different problem classes such as convex and log-log convex programming. They also help CVXPY target different categories of solvers, such as quadratic programming solvers and conic solvers.
Appropriating terminology from software compilers, we classify reductions as either middle-end reductions or back-end reductions. A reduction that simplifies a source problem without regard to the targeted solver is called a middle-end reduction, whereas a reduction that takes a source problem and converts it to a form acceptable to a category of solvers is called a back-end reduction. Each solver (along with the mode in which it is invoked) is called a back-end or target.
Here’s a breakdown of CVXPY’s reductions:
Core classes¶
Reductions exchange data and operate by way of the following classes. Other data structures can be used, such as dicts keyed by strings, but these are the main classes which define the Reduction system.
Solution¶
- class cvxpy.reductions.solution.Solution(status, opt_val, primal_vars, dual_vars, attr)[source]¶
A solution to an optimization problem.
- status¶
The status code.
- Type:
str
- opt_val¶
The optimal value.
- Type:
float
- primal_vars¶
A map from variable ids to optimal values.
- Type:
dict of id to NumPy ndarray
- dual_vars¶
A map from constraint ids to dual values.
- Type:
dict of id to NumPy ndarray
- attr¶
Miscelleneous information propagated up from a solver.
- Type:
dict
Reduction¶
- class cvxpy.reductions.reduction.Reduction(problem=None)[source]¶
Abstract base class for reductions.
A reduction is an actor that transforms a problem into an equivalent problem. By equivalent we mean that there exists a mapping between solutions of either problem: if we reduce a problem \(A\) to another problem \(B\) and then proceed to find a solution to \(B\), we can convert it to a solution of \(A\) with at most a moderate amount of effort.
A reduction that is instantiated with a non-None problem offers two key methods: reduce and retrieve. The reduce() method converts the problem the reduction was instantiated with to an equivalent problem. The retrieve() method takes as an argument a Solution for the equivalent problem and returns a Solution for the problem owned by the reduction.
Every reduction offers three low-level methods: accepts, apply, and invert. The accepts method of a particular reduction specifies the types of problems that it is applicable to; the apply method takes a problem and reduces it to an equivalent form, and the invert method maps solutions from reduced-to problems to their problems of provenance.
- Parameters:
problem (Problem) – A problem owned by this reduction; possibly None.
- __init__(problem=None) None [source]¶
Construct a reduction for reducing problem.
If problem is not None, then a subsequent invocation of reduce() will reduce problem and return an equivalent one.
- accepts(problem)[source]¶
States whether the reduction accepts a problem.
- Parameters:
problem (Problem) – The problem to check.
- Returns:
True if the reduction can be applied, False otherwise.
- Return type:
bool
- abstract apply(problem)[source]¶
Applies the reduction to a problem and returns an equivalent problem.
- Parameters:
problem (Problem) – The problem to which the reduction will be applied.
- Returns:
Problem or dict – An equivalent problem, encoded either as a Problem or a dict.
InverseData, list or dict – Data needed by the reduction in order to invert this particular application.
- abstract invert(solution, inverse_data)[source]¶
Returns a solution to the original problem given the inverse_data.
- reduce()[source]¶
Reduces the owned problem to an equivalent problem.
- Returns:
An equivalent problem, encoded either as a Problem or a dict.
- Return type:
Problem or dict
- Raises:
ValueError – If this Reduction was constructed without a Problem.
Chain¶
- class cvxpy.reductions.chain.Chain(problem=None, reductions=None)[source]¶
Bases:
Reduction
A logical grouping of multiple reductions into a single reduction.
- accepts(problem) bool [source]¶
A problem is accepted if the sequence of reductions is valid.
In particular, the i-th reduction must accept the output of the i-1th reduction, with the first reduction (self.reductions[0]) in the sequence taking as input the supplied problem.
- Parameters:
problem (Problem) – The problem to check.
- Returns:
True if the chain can be applied, False otherwise.
- Return type:
bool
- apply(problem, verbose: bool = False)[source]¶
Applies the chain to a problem and returns an equivalent problem.
- Parameters:
problem (Problem) – The problem to which the chain will be applied.
verbose (bool, optional) – Whehter to print verbose output.
- Returns:
Problem or dict – The problem yielded by applying the reductions in sequence, starting at self.reductions[0].
list – The inverse data yielded by each of the reductions.
SolvingChain¶
- class cvxpy.reductions.solvers.solving_chain.SolvingChain(problem=None, reductions=None)[source]¶
Bases:
Chain
A reduction chain that ends with a solver.
- Parameters:
reductions (list[Reduction]) – A list of reductions. The last reduction in the list must be a solver instance.
- solver¶
The solver, i.e., reductions[-1].
- Type:
Solver
- prepend(chain) SolvingChain [source]¶
Create and return a new SolvingChain by concatenating chain with this instance.
- solve(problem, warm_start: bool, verbose: bool, solver_opts)[source]¶
Solves the problem by applying the chain.
Applies each reduction in the chain to the problem, solves it, and then inverts the chain to return a solution of the supplied problem.
- solve_via_data(problem, data, warm_start: bool = False, verbose: bool = False, solver_opts={})[source]¶
Solves the problem using the data output by the an apply invocation.
The semantics are:
data, inverse_data = solving_chain.apply(problem) solution = solving_chain.invert(solver_chain.solve_via_data(data, ...))
which is equivalent to writing
solution = solving_chain.solve(problem, ...)
- Parameters:
problem (Problem) – The problem to solve.
data (map) – Data for the solver.
warm_start (bool) – Whether to warm start the solver.
verbose (bool) – Whether to enable solver verbosity.
solver_opts (dict) – Solver specific options.
- Returns:
The information returned by the solver; this is not necessarily a Solution object.
- Return type:
raw solver solution