Skip to content

Commit

Permalink
Update intro problem docu (#195)
Browse files Browse the repository at this point in the history
  • Loading branch information
bvenn authored Apr 19, 2023
1 parent 22f7878 commit 1e18c6b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,11 @@ let settings = {
SolverType = SolverType.CBC
MaxDuration = 10_000L
WriteLPFile = None
WriteMPSFile = None
}
// Call the `solve` function in the Solve module to evaluate the model
let result = solve settings model
// Call the `solve` function in the Solver module to evaluate the model
let result = Solver.solve settings model
```

The `solve` function returns a `SolveResult` which is a DU with two cases: Optimal or Suboptimal. If the `SolveResult` is the `Optimal` case, it will contain a `Solution`. If the `SolveResult` case is `Suboptimal`, it will hold a `string` which describes what went wrong. In this case the `SolveResult` case is `Optimal` so we can match the case and print out the solution values. The `Solution` type contains `DecisionResult` which is a `Map<Decision,float>`. `DecisionResult` tells you which values the `Solver` picked for the `Decision`s you provided it. The field in the `Solution` is `ObjectiveResult` which is a `float` which tells you how well the `Solver` was able to do.
Expand Down
7 changes: 7 additions & 0 deletions docs/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
### 2.4.9 - Wednesday, October 19th, 2022
* Fix problem with Units of Measure when multiplying float and LinearExpression

### 2.4.8 - Friday, June 17th, 2022
* Fix F# 5.0 dependency
* Updated dependencies

### 2.4.7 - Tuesday, December 14th, 2021
* Updated OPTANO.Modeling to 3.9.2.537

Expand Down

0 comments on commit 1e18c6b

Please sign in to comment.