always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first pass at linear solver doc

Browse Source
This commit is contained in:
Laurent Perron
2019-07-15 14:27:40 -07:00
parent b3c9ac9de8
commit bfb86b20a0
175 changed files with 20472 additions and 2734 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/java/annotated.html
View File

@@ -170,7 +170,7 @@
<tr id="row_0_0_0_3_0_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1LinearSolver.html" target="_self">LinearSolver</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_1_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1main__research__linear__solver.html" target="_self">main_research_linear_solver</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_2_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1main__research__linear__solverJNI.html" target="_self">main_research_linear_solverJNI</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_3_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPConstraint.html" target="_self">MPConstraint</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_3_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPConstraint.html" target="_self">MPConstraint</a></td><td class="desc">The class for constraints of a Mathematical Programming (MP) model </td></tr>
<tr id="row_0_0_0_3_4_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_4_" class="arrow" onclick="toggleFolder('0_0_0_3_4_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPConstraintProto.html" target="_self">MPConstraintProto</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_4_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPConstraintProto_1_1Builder.html" target="_self">Builder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_5_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPConstraintProtoOrBuilder.html" target="_self">MPConstraintProtoOrBuilder</a></td><td class="desc"></td></tr>
@@ -189,31 +189,34 @@
<tr id="row_0_0_0_3_13_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPModelRequest_1_1Builder.html" target="_self">Builder</a></td><td class="desc">Protobuf type </td></tr>
<tr id="row_0_0_0_3_13_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPModelRequest_1_1SolverType.html" target="_self">SolverType</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_14_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPModelRequestOrBuilder.html" target="_self">MPModelRequestOrBuilder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_15_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPObjective.html" target="_self">MPObjective</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_15_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPObjective.html" target="_self">MPObjective</a></td><td class="desc">A class to express a linear objective </td></tr>
<tr id="row_0_0_0_3_16_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_16_" class="arrow" onclick="toggleFolder('0_0_0_3_16_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolutionResponse.html" target="_self">MPSolutionResponse</a></td><td class="desc">Protobuf type </td></tr>
<tr id="row_0_0_0_3_16_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolutionResponse_1_1Builder.html" target="_self">Builder</a></td><td class="desc">Protobuf type </td></tr>
<tr id="row_0_0_0_3_17_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolutionResponseOrBuilder.html" target="_self">MPSolutionResponseOrBuilder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_18_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_18_" class="arrow" onclick="toggleFolder('0_0_0_3_18_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver.html" target="_self">MPSolver</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_18_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1BasisStatus.html" target="_self">BasisStatus</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_18_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1OptimizationProblemType.html" target="_self">OptimizationProblemType</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_18_2_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1ResultStatus.html" target="_self">ResultStatus</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_18_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_18_" class="arrow" onclick="toggleFolder('0_0_0_3_18_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver.html" target="_self">MPSolver</a></td><td class="desc">This mathematical programming (MP) solver class is the main class<br />
though which users build and solve problems </td></tr>
<tr id="row_0_0_0_3_18_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1BasisStatus.html" target="_self">BasisStatus</a></td><td class="desc">Advanced usage: possible basis status values for a variable and the slack<br />
variable of a linear constraint </td></tr>
<tr id="row_0_0_0_3_18_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1OptimizationProblemType.html" target="_self">OptimizationProblemType</a></td><td class="desc">The type of problems (LP or MIP) that will be solved and the underlying<br />
solver (GLOP, GLPK, CLP, CBC or SCIP) that will solve them </td></tr>
<tr id="row_0_0_0_3_18_2_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolver_1_1ResultStatus.html" target="_self">ResultStatus</a></td><td class="desc">The status of solving the problem </td></tr>
<tr id="row_0_0_0_3_19_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_19_" class="arrow" onclick="toggleFolder('0_0_0_3_19_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverCommonParameters.html" target="_self">MPSolverCommonParameters</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_19_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverCommonParameters_1_1Builder.html" target="_self">Builder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_19_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverCommonParameters_1_1LPAlgorithmValues.html" target="_self">LPAlgorithmValues</a></td><td class="desc">Protobuf enum </td></tr>
<tr id="row_0_0_0_3_20_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverCommonParametersOrBuilder.html" target="_self">MPSolverCommonParametersOrBuilder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_21_" class="arrow" onclick="toggleFolder('0_0_0_3_21_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters.html" target="_self">MPSolverParameters</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1DoubleParam.html" target="_self">DoubleParam</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1IncrementalityValues.html" target="_self">IncrementalityValues</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_2_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1IntegerParam.html" target="_self">IntegerParam</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_3_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1LpAlgorithmValues.html" target="_self">LpAlgorithmValues</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_4_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1PresolveValues.html" target="_self">PresolveValues</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_5_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1ScalingValues.html" target="_self">ScalingValues</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_21_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_21_" class="arrow" onclick="toggleFolder('0_0_0_3_21_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters.html" target="_self">MPSolverParameters</a></td><td class="desc">This class stores parameter settings for LP and MIP solvers </td></tr>
<tr id="row_0_0_0_3_21_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1DoubleParam.html" target="_self">DoubleParam</a></td><td class="desc">Enumeration of parameters that take continuous values </td></tr>
<tr id="row_0_0_0_3_21_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1IncrementalityValues.html" target="_self">IncrementalityValues</a></td><td class="desc">Advanced usage: Incrementality options </td></tr>
<tr id="row_0_0_0_3_21_2_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1IntegerParam.html" target="_self">IntegerParam</a></td><td class="desc">Enumeration of parameters that take integer or categorical values </td></tr>
<tr id="row_0_0_0_3_21_3_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1LpAlgorithmValues.html" target="_self">LpAlgorithmValues</a></td><td class="desc">LP algorithm to use </td></tr>
<tr id="row_0_0_0_3_21_4_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1PresolveValues.html" target="_self">PresolveValues</a></td><td class="desc">For each categorical parameter, enumeration of possible values </td></tr>
<tr id="row_0_0_0_3_21_5_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverParameters_1_1ScalingValues.html" target="_self">ScalingValues</a></td><td class="desc">Advanced usage: Scaling options </td></tr>
<tr id="row_0_0_0_3_22_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSolverResponseStatus.html" target="_self">MPSolverResponseStatus</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_23_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_23_" class="arrow" onclick="toggleFolder('0_0_0_3_23_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSosConstraint.html" target="_self">MPSosConstraint</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_23_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSosConstraint_1_1Builder.html" target="_self">Builder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_23_1_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="enumcom_1_1google_1_1ortools_1_1linearsolver_1_1MPSosConstraint_1_1Type.html" target="_self">Type</a></td><td class="desc">Protobuf enum </td></tr>
<tr id="row_0_0_0_3_24_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPSosConstraintOrBuilder.html" target="_self">MPSosConstraintOrBuilder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_25_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPVariable.html" target="_self">MPVariable</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_25_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPVariable.html" target="_self">MPVariable</a></td><td class="desc">The class for variables of a Mathematical Programming (MP) model </td></tr>
<tr id="row_0_0_0_3_26_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_3_26_" class="arrow" onclick="toggleFolder('0_0_0_3_26_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPVariableProto.html" target="_self">MPVariableProto</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_26_0_" style="display:none;"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1linearsolver_1_1MPVariableProto_1_1Builder.html" target="_self">Builder</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_3_27_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1linearsolver_1_1MPVariableProtoOrBuilder.html" target="_self">MPVariableProtoOrBuilder</a></td><td class="desc"></td></tr>