update documentation

Author: jbytecode

docs/src/algorithms.md

@@ -5,12 +5,28 @@
 OperationsResearchModels.solve(a::AssignmentProblem)
 ```
 
+```@docs
+OperationsResearchModels.AssignmentProblem
+```
+
+```@docs
+OperationsResearchModels.AssignmentResult
+```
+
 ## Transportation Problem
 
 ```@docs
 OperationsResearchModels.solve(t::TransportationProblem)
 ```
 
+```@docs
+OperationsResearchModels.TransportationProblem
+```
+
+```@docs
+OperationsResearchModels.TransportationResult
+```
+
 ### Initial basic solutions for a transportation problem 
 
 #### North-west Corner Method 

src/assignment.jl

@@ -9,11 +9,37 @@ export AssignmentResult
 import ..OperationsResearchModels: solve
 
 
+"""
+    AssignmentProblem
+
+# Arguments
+
+- `costs::Array{T,2}`: The cost matrix of the assignment problem.
+
+# Description
+
+The `AssignmentProblem` struct represents an assignment problem with a cost matrix.
+"""
 struct AssignmentProblem{T<:Real}
     costs::Array{T,2}
 end
 
 
+
+"""
+    AssignmentResult(problem, solution, cost) 
+
+# Arguments
+
+- `problem::AssignmentProblem`: The original assignment problem.
+- `solution::Matrix`: The solution matrix of the assignment problem.
+- `cost::Real`: The optimal cost of the assignment.
+
+# Description
+
+The `AssignmentResult` struct represents the result of solving an assignment problem.
+It contains the original problem, the solution matrix, and the optimal cost.
+"""
 struct AssignmentResult
     problem::AssignmentProblem
     solution::Matrix

src/simplex.jl

@@ -490,11 +490,11 @@ Description:
 
 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.
+- `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:
 
@@ -555,8 +555,8 @@ Description:
 
 Arguments:
 
-- A::Matrix: The matrix to find the inverse.
-- verbose::Bool: If true, the intermediate steps are displayed. Default is true.
+- `A::Matrix`: The matrix to find the inverse.
+- `verbose::Bool`: If true, the intermediate steps are displayed. Default is true.
 
 Returns:
 

src/transportation.jl

@@ -14,13 +14,40 @@ export balance
 import ..OperationsResearchModels: solve
 
 
+"""
+    TransportationProblem
+
+# Arguments
+
+- `costs::Array{T,2}`: The cost matrix of the transportation problem.
+- `demand::Array{T,1}`: The demand vector of the transportation problem.
+- `supply::Array{T,1}`: The supply vector of the transportation problem.
 
+# Description
+
+The `TransportationProblem` struct represents a transportation problem with a cost matrix, demand vector, and supply vector.
+"""
 mutable struct TransportationProblem{T<:Real}
     costs::Array{T,2}
     demand::Array{T,1}
     supply::Array{T,1}
 end
 
+
+"""
+    TransportationResult(problem, balancedProblem, solution, cost)
+
+# Arguments
+
+- `problem::TransportationProblem`: The original transportation problem.
+- `balancedProblem::TransportationProblem`: The balanced transportation problem.
+- `solution::Matrix`: The solution matrix of the transportation problem.
+- `cost::Real`: The optimal cost of the transportation problem.
+
+# Description
+The `TransportationResult` struct represents the result of solving a transportation problem.
+It contains the original problem, the balanced problem, the solution matrix, and the optimal cost.
+"""
 struct TransportationResult
     originalProblem::TransportationProblem
     balancedProblem::TransportationProblem