Skip to content

Commit 00ec912

Browse files
authored
Update README and ChangeLog (#5)
* Fix README formatting * Update ChangeLog
1 parent 078d611 commit 00ec912

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

ChangeLog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# Changelog for simplex-haskell
22

33
## Unreleased changes
4+
5+
- Setup CI
6+
- Use ormolu formatter
7+
- Switch to Cabal
8+
9+
## [v0.1.0.0](https://github.com/rasheedja/LPPaver/tree/v0.1.0.0)
10+
11+
- Initial release

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,18 @@ The second item is a list of `Integer` variables mapped to their optimized value
6565
If a variable is not in this list, the variable is equal to 0.
6666

6767
### Two-Phase Simplex
68+
6869
`twoPhaseSimplex` performs both phases of the simplex method.
6970
It has the type:
71+
7072
```haskell
7173
twoPhaseSimplex :: ObjectiveFunction -> [PolyConstraint] -> Maybe (Integer, [(Integer, Rational)])
7274
```
75+
7376
The return type is the same as that of `optimizeFeasibleSystem`
7477

7578
### Extracting Results
79+
7680
The result of the objective function is present in the return type of both `twoPhaseSimplex` and `optimizeFeasibleSystem`, but this can be difficult to grok in systems with many variables, so the following function will extract the value of the objective function for you.
7781

7882
```haskell
@@ -105,6 +109,7 @@ twoPhaseSimplex (fst exampleFunction) (snd exampleFunction)
105109
```
106110

107111
The result of the call above is:
112+
108113
```haskell
109114
Just
110115
(7, -- Integer representing objective function

0 commit comments

Comments
 (0)