(#2) Add and update documentation in Simplex module

Author: jbytecode

docs/src/simplex.md

@@ -1,11 +1,25 @@
 # The Simplex Method
 
-## Simplex
+
+## createsimplexproblem
 
 ```@docs 
 OperationsResearchModels.createsimplexproblem
 ```
 
+## solve!
+
+```@docs 
+OperationsResearchModels.solve!(s::SimplexProblem)
+```
+
+## simplexiterations
+
+```@docs 
+OperationsResearchModels.simplexiterations
+```
+
+
 ## Gauss Jordan steps for matrix inversion
 
 ```@docs

src/OperationsResearchModels.jl

@@ -12,8 +12,12 @@ using JuMP, HiGHS
 # solve(a::AssignmentProblem)::AssignmentResult
 # solve(g::Game)::GameResult
 # solve(m::MstProblem)::MstResult
+# solve(t::TravelingSalesmanProblem)::TravelingSalesmanResult
 solve() = nothing 
 
+# solve!(s::SimplexProblem)::SimplexProblem
+solve!() = nothing
+
 # balance(m::TransportationProblem)::TransportationProblem
 # balance(a::AssignmentProblem)::AssignmentProblem
 balance() = nothing
@@ -24,6 +28,7 @@ isbalanced() = nothing
 
 
 export solve 
+export solve!
 export balance
 export isbalanced 
 
@@ -88,7 +93,7 @@ import .Latex: latex
 import .Johnsons: JohnsonResult, johnsons, JohnsonException, makespan, johnsons_ga
 import .RandomKeyGA: Chromosome, run_ga
 import .TravelingSalesman: TravelingSalesmanResult, TravelingSalesmanProblem
-import .Simplex: SimplexProblem, simplexiterations, createsimplexproblem, gaussjordan
+import .Simplex: SimplexProblem, simplexiterations, createsimplexproblem, gaussjordan, OptimizationType
 
 export TransportationProblem, TransportationResult, balance, isbalanced, northwestcorner, leastcost
 export Connection, ShortestPathResult, MaximumFlowResult, MinimumCostFlowResult, nodes
@@ -106,7 +111,7 @@ export latex
 export Chromosome, run_ga
 export JohnsonResult, johnsons, JohnsonException, makespan, johnsons_ga
 export TravelingSalesmanResult, TravelingSalesmanProblem
-export simplexiterations, SimplexProblem, createsimplexproblem, gaussjordan
+export simplexiterations, SimplexProblem, createsimplexproblem, gaussjordan, OptimizationType
 
 export JuMP, HiGHS
 

src/simplex.jl

@@ -11,11 +11,11 @@ export singleiteration!
 export simplexiterations
 export simplexpretty
 export createsimplexproblem
-export solve!
 export gaussjordan
 
-import ..Utility: numround
 
+import ..Utility: numround
+import ..OperationsResearchModels: solve!
 
 @enum OptimizationType begin
     Maximize
@@ -412,6 +412,22 @@ function singleiteration!(s::SimplexProblem)
     update!(s, enteringvariableindex, rowindex)
 end
 
+"""
+    solve!(s::SimplexProblem)::SimplexProblem
+
+# Description 
+
+    Solves the given SimplexProblem using the Simplex algorithm. The `solve!` function 
+    modifies the input SimplexProblem in place.
+
+# Arguments
+
+- `s::SimplexProblem`: The SimplexProblem to solve.
+
+# Returns
+
+- `SimplexProblem`: The solved SimplexProblem.
+"""
 function solve!(s::SimplexProblem)::SimplexProblem
     standardform!(s)
 
@@ -424,6 +440,24 @@ function solve!(s::SimplexProblem)::SimplexProblem
     return s
 end
 
+
+"""
+    simplexiterations(s::SimplexProblem)::Vector{SimplexProblem}
+
+# Description 
+
+    This function performs the Simplex iterations on the given SimplexProblem and returns the 
+    history of SimplexProblem states.
+
+# Arguments
+
+- `s::SimplexProblem`: The SimplexProblem to iterate.
+
+# Returns
+
+- `Vector{SimplexProblem}`: The history of SimplexProblem states (by iterations).
+
+"""
 function simplexiterations(s::SimplexProblem)::Vector{SimplexProblem}
     iterations = Vector{SimplexProblem}(undef, 0)
 
@@ -484,23 +518,23 @@ end
 """
     createsimplexproblem(obj::Vector, amat::Matrix, rhs::Vector, dir::Vector, opttype::OptimizationType)::SimplexProblem
 
-Description:
+# Description
 
     This function creates a SimplexProblem object from the given parameters. 
 
-Arguments:
+# Arguments
 
 - `obj::Vector`: The objective function coefficients.
 - `amat::Matrix`: The LHS of the constraints.
 - `rhs::Vector`: The RHS of the constraints.
 - `dir::Vector`: The directions of the constraints. Can be a vector of LE (<=), GE (>=), or EQ (==).
 - `opttype::OptimizationType`: The type of the optimization. Can be Maximize or Minimize.
 
-Returns:
+# Returns
 
     A SimplexProblem object.
 
-Example:
+# Example
 
 Suppose the linear programming problem is as follows:
 
@@ -549,20 +583,20 @@ end
 """
     gaussjordan(A::Matrix; verbose::Bool = true)::Matrix
 
-Description:
+# Description
 
     Attaches an Identity matrix to the right of the given matrix A and applies the Gauss-Jordan elimination method to find the inverse of the given matrix.
 
-Arguments:
+# Arguments
 
 - `A::Matrix`: The matrix to find the inverse.
 - `verbose::Bool`: If true, the intermediate steps are displayed. Default is true.
 
-Returns:
+# Returns
 
     The inverse of the given matrix.
 
-Example:
+# Example
 
 ```julia
 julia> A = [1.0 2.0 3.0; 4.0 5.0 6.0; 7.0 8.0 10.0]

src/travelingsalesman.jl

@@ -16,7 +16,8 @@ export TravelingSalesmanResult
     A data structure to hold the problem definition of the traveling salesman problem.
 
 # Fields
-    - `distancematrix::Matrix{Real}`: The distance matrix representing the distances between cities.
+
+- `distancematrix::Matrix{Real}`: The distance matrix representing the distances between cities.
 """
 struct TravelingSalesmanProblem
     distancematrix::Matrix{Real}
@@ -32,8 +33,8 @@ end
     A data structure to hold the result of the traveling salesman problem.
 
 # Fields
-    - `route::Vector{Int}`: The best route found.
-    - `cost::Float64`: The cost of the best route.
+- `route::Vector{Int}`: The best route found.
+- `cost::Float64`: The cost of the best route.
 """
 struct TravelingSalesmanResult
     route::Vector{Int}