Skip to content

Commit 138d4af

Browse files
jajhalljajhall
committed
Documentation builds OK
1 parent 3d2dbac commit 138d4af

File tree

10 files changed

+51
-48
lines changed

10 files changed

+51
-48
lines changed

‎docs/src/guide/advanced.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ and
2929
yield a specific row or column of ``B^{-1}A``. In all cases,
3030
HiGHS can return the number and indices of the nonzeros in the result.
3131

32-
## Irreducible infeasibility system (IIS) detection(@id highs-iis)
32+
## [Irreducible infeasibility system (IIS) detection](@id highs-iis)
3333

3434
An Irreducible infeasibility system (IIS) consists of a set of
3535
variables and a set of constraints in a model, together with
@@ -39,10 +39,10 @@ bound is removed, then the system can be satisfied (so is feasible).
3939

4040
HiGHS has an IIS facility that is under development. Currently it can only be used for LPs.
4141

42-
## IIS-related methods in the `Highs` class
42+
### IIS-related methods in the `Highs` class
4343

4444
- `const HighsLp& getIisLp()`: Return a const reference to the internal IIS LP instance
45-
- `HighsStatus getIis(HighsIis& iis)`: Try to find an IIS for the incumbent model. Gets the internal [`HighsIis`](@ref highs-iis-class) instance, returning `HighsStatus::kError` if the calculation failed. Note that if the incumbent model is found to be feasible, this is a "success", and `HighsStatus::kOk` is returned.
45+
- `HighsStatus getIis(HighsIis& iis)`: Try to find an IIS for the incumbent model. Gets the internal [HighsIis](@ref) instance, returning `HighsStatus::kError` if the calculation failed. Note that if the incumbent model is found to be feasible, this is a "success", and `HighsStatus::kOk` is returned.
4646
- ` HighsStatus writeIisModel(const std::string& filename = "")`: Write out the internal IIS LP instance to a file.
4747

4848

‎docs/src/structures/classes/HighsHessian.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
A Hessian matrix is communicated via an instance of the HighsHessian class.
44

55
- `dim_`: Scalar of type integer - Dimension of the Hessian
6-
- `format\_`: Scalar of [HessianFormat](@ref) type - Format of the Hessian
7-
- `start\_`: Vector of integer type - Start of each compressed column in the Hessian
8-
- `index\_`: Vector of integer type - Indices of the nonzeros in the Hessian
9-
- `value\_`: Vector of double type - Values of the nonzeros in the Hessian
6+
- `format_`: Scalar of [HessianFormat](@ref) type - Format of the Hessian
7+
- `start_`: Vector of integer type - Start of each compressed column in the Hessian
8+
- `index_`: Vector of integer type - Indices of the nonzeros in the Hessian
9+
- `value_`: Vector of double type - Values of the nonzeros in the Hessian

‎docs/src/structures/classes/HighsIis.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# [HighsIis](@id highs-iis-class)
1+
# HighsIis
22

33
Irreducible infeasibility system (IIS) data are communicated via an instance of the `HighsIis` class.
44

5-
- `valid\_`: The data in the HighsIis instance is valid
6-
- `strategy\_`: The IIS strategy used
7-
- `col\_index\_`: The indices of model columns in the IIS
8-
- `row\_index\_`: The indices of model rows in the IIS
9-
- `col\_bound\_`: The bounds on each column that define the IIS
10-
- `row\_bound\_`: The bounds on each row that define the IIS
11-
- `col\_status\_`: Indicates whether a column in the model is in an IIS, may be in an IIS, or is not in an IIS
12-
- `row\_status\_`: Indicates whether a row in the model is in an IIS, may be in an IIS, or is not in an IIS
13-
- `info\_`: Data on the time and number of simplex iterations required to form the IIS
14-
- `model\_`: A `HighsModel` consisting of the variables, constraints and bounds in the IIS. Currently only its `HighsLp` instance is relevant
5+
- `valid_`: The data in the `HighsIis` instance is valid
6+
- `strategy_`: The IIS strategy used
7+
- `col_index_`: The indices of model columns in the IIS
8+
- `row_index_`: The indices of model rows in the IIS
9+
- `col_bound_`: The bounds on each column that define the IIS
10+
- `row_bound_`: The bounds on each row that define the IIS
11+
- `col_status_`: Indicates whether a column in the model is in an IIS, may be in an IIS, or is not in an IIS
12+
- `row_status_`: Indicates whether a row in the model is in an IIS, may be in an IIS, or is not in an IIS
13+
- `info_`: Data on the time and number of simplex iterations required to form the IIS
14+
- `model_`: A [HighsModel](@ref) consisting of the variables, constraints and bounds in the IIS. Currently only its [HighsLp](@ref) instance is relevant
1515

1616

‎docs/src/structures/classes/HighsLp.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
An LP model is communicated via an instance of the `HighsLp` class
44

5-
- `num\_col\_`: Scalar of type integer - Number of columns in the model
6-
- `num\_row\_`: Scalar of type integer - Number of rows in the model
7-
- `col\_cost\_`: Vector of type double - Coefficients of the linear term in the objective function
8-
- `col\_lower\_`: Vector of type double - Lower bounds on the variables
9-
- `col\_upper\_`: Vector of type double - Upper bounds on the variables
10-
- `row\_lower\_`: Vector of type double - Lower bounds on the constraints
11-
- `row\_upper\_`: Vector of type double - Upper bounds on the constraints
12-
- `a\_matrix\_`: Instance of [HighsSparseMatrix](@ref) class - Constraint matrix
13-
- `sense\_`: Scalar of type [ObjSense](@ref) - Optimization sense of the model
14-
- `offset\_`: Scalar of type double - Constant term in the objective function
15-
- `model\_name\_`: Scalar of type string - Name of the model
16-
- `objective\_name\_`: Scalar of type string - Name of the objective function
17-
- `col\_names\_`: Vector of type string - Names of the variables
18-
- `row\_names\_`: Vector of type string - Names of the constraints
19-
- `integrality\_`: Vector of type [HighsVarType](@ref) - Type of each variable
5+
- `num_col_`: Scalar of type integer - Number of columns in the model
6+
- `num_row_`: Scalar of type integer - Number of rows in the model
7+
- `col_cost_`: Vector of type double - Coefficients of the linear term in the objective function
8+
- `col_lower_`: Vector of type double - Lower bounds on the variables
9+
- `col_upper_`: Vector of type double - Upper bounds on the variables
10+
- `row_lower_`: Vector of type double - Lower bounds on the constraints
11+
- `row_upper_`: Vector of type double - Upper bounds on the constraints
12+
- `a_matrix_`: Instance of [HighsSparseMatrix](@ref) class - Constraint matrix
13+
- `sense_`: Scalar of type [ObjSense](@ref) - Optimization sense of the model
14+
- `offset_`: Scalar of type double - Constant term in the objective function
15+
- `model_name_`: Scalar of type string - Name of the model
16+
- `objective_name_`: Scalar of type string - Name of the objective function
17+
- `col_names_`: Vector of type string - Names of the variables
18+
- `row_names_`: Vector of type string - Names of the constraints
19+
- `integrality_`: Vector of type [HighsVarType](@ref) - Type of each variable

‎docs/src/structures/classes/HighsModel.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
A QP model is communicated via an instance of the HighsModel class
44

5-
- `lp\_`: Instance of [HighsLp](@ref) class - LP components of the model
6-
- `hessian\_`: Instance of [HighsHessian](@ref) class - Hessian matrix
5+
- `lp_`: Instance of [HighsLp](@ref) class - LP components of the model
6+
- `hessian_`: Instance of [HighsHessian](@ref) class - Hessian matrix

‎docs/src/structures/classes/HighsSparseMatrix.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The constraint matrix of an LP model is communicated via an instance of the HighsSparseMatrix class
44

5-
- `format\_`: Scalar of [MatrixFormat](@ref) type - Format of the matrix
6-
- `num\_col\_ `: Scalar of integer type - Number of columns in the matrix
7-
- `num\_row\_`: Scalar of integer type - Number of rows in the matrix
8-
- `start\_`: Vector of integer type - Start of each compressed vector in the matrix
9-
- `index\_`: Vector of integer type - Indices of the nonzeros in the matrix
10-
- `value\_`: Vector of double type - Values of the nonzeros in the matrix
5+
- `format_`: Scalar of [MatrixFormat](@ref) type - Format of the matrix
6+
- `num_col_ `: Scalar of integer type - Number of columns in the matrix
7+
- `num_row_`: Scalar of integer type - Number of rows in the matrix
8+
- `start_`: Vector of integer type - Start of each compressed vector in the matrix
9+
- `index_`: Vector of integer type - Indices of the nonzeros in the matrix
10+
- `value_`: Vector of double type - Values of the nonzeros in the matrix

‎docs/src/structures/classes/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ The data members of fundamental classes in HiGHS are defined in this section.
66
* [HighsLp](@ref)
77
* [HighsHessian](@ref)
88
* [HighsModel](@ref)
9+
* [HighsIis](@ref)
910

1011
Class data members for internal use only are not documented.

‎highs/lp_data/Highs.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1037,8 +1037,8 @@ HighsStatus Highs::optimizeModel() {
10371037
// kHighsDebugLevelCostly;
10381038
// kHighsDebugLevelMax;
10391039
//
1040-
// if (model_.lp_.num_row_>0 && model_.lp_.num_col_>0)
1041-
// writeLpMatrixPicToFile(options_, "LpMatrix", model_.lp_);
1040+
if (model_.lp_.num_row_>0 && model_.lp_.num_col_>0)
1041+
writeLpMatrixPicToFile(options_, "LpMatrix", model_.lp_);
10421042
if (options_.highs_debug_level < min_highs_debug_level)
10431043
options_.highs_debug_level = min_highs_debug_level;
10441044

‎highs/lp_data/IIS.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎highs/lp_data/Iis.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# HiGHS irreducible infeasibility system (IIS) facility
2+
3+
Further to documentation in https://ergo-code.github.io/HiGHS/stable/guide/advanced/
4+
5+
6+
7+

0 commit comments

Comments
 (0)