Skip to content

Commit 186b84b

Browse files
committed
update documentation
1 parent f2f7a8a commit 186b84b

13 files changed

Lines changed: 206 additions & 129 deletions

docs/make.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,18 @@ makedocs(
88
),
99
sitename = "OperationsResearchModels.jl",
1010
authors = "Mehmet Hakan Satman",
11-
pages = ["Algorithms" => "algorithms.md"],
11+
pages = [
12+
"Knapsack" => "knapsack.md",
13+
"Assignment" => "assignment.md",
14+
"Transportation" => "transportation.md",
15+
"Network" => "network.md",
16+
"Project Analysis" => "project.md",
17+
"Location Selection" => "locationselection.md",
18+
"Traveling Salesman" => "travelingsalesman.md",
19+
"Scheduling" => "scheduling.md",
20+
"The Simplex Method" => "simplex.md",
21+
"Zero-sum Games" => "game.md",
22+
],
1223
)
1324

1425

docs/src/algorithms.md

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

docs/src/assignment.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Assignment Problem
2+
```@docs
3+
OperationsResearchModels.solve(a::AssignmentProblem)
4+
```
5+
6+
```@docs
7+
OperationsResearchModels.AssignmentProblem
8+
```
9+
10+
```@docs
11+
OperationsResearchModels.AssignmentResult
12+
```

docs/src/game.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Zero-Sum Games
2+
3+
```@docs
4+
OperationsResearchModels.game
5+
```
6+
7+
```@docs
8+
OperationsResearchModels.game_solver
9+
```
10+
11+
```@docs
12+
OperationsResearchModels.GameResult
13+
```

docs/src/knapsack.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# The Classical Knapsack Problem
2+
3+
```@docs
4+
OperationsResearchModels.solve(p::KnapsackProblem)
5+
```

docs/src/locationselection.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## pmedian
2+
3+
```@docs
4+
OperationsResearchModels.pmedian
5+
```
6+
7+
## pmedian with distances
8+
9+
```@docs
10+
OperationsResearchModels.pmedian_with_distances
11+
```

docs/src/network.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Network Models
2+
3+
## Shortest Path
4+
5+
```@docs
6+
OperationsResearchModels.solve(t::ShortestPathProblem)
7+
```
8+
9+
## Maximum Flow
10+
11+
```@docs
12+
OperationsResearchModels.solve(t::MaximumFlowProblem)
13+
```
14+
15+
## Minimum Spanning Tree
16+
17+
```@docs
18+
OperationsResearchModels.solve(p::MstProblem)
19+
```

docs/src/project.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Project Analysis
2+
3+
4+
## CPM (Critical Path Method)
5+
```@docs
6+
OperationsResearchModels.solve(problem::CpmProblem)
7+
```
8+
9+
### CPM Activity
10+
```@docs
11+
OperationsResearchModels.CpmActivity
12+
```
13+
14+
15+
## PERT (Project Evaluation and Review Technique)
16+
```@docs
17+
OperationsResearchModels.solve(problem::PertProblem)
18+
```
19+
20+
### PERT Activity
21+
```@docs
22+
OperationsResearchModels.PertActivity
23+
```

docs/src/scheduling.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Scheduling Problems
2+
3+
## Johnson's Rule for Flow-shop Scheduling
4+
5+
```@docs
6+
OperationsResearchModels.johnsons
7+
```
8+
9+
### Genetic Algorithm for the problems that cannot be solved with using Johnson's Rule
10+
11+
```@docs
12+
OperationsResearchModels.johnsons_ga
13+
```
14+
15+
### Makespan
16+
17+
```@docs
18+
OperationsResearchModels.makespan
19+
```

docs/src/simplex.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# The Simplex Method
2+
3+
## Simplex
4+
5+
```@docs
6+
OperationsResearchModels.createsimplexproblem
7+
```
8+
9+
## Gauss Jordan steps for matrix inversion
10+
11+
```@docs
12+
OperationsResearchModels.gaussjordan
13+
```

0 commit comments

Comments
 (0)