wip

Author: rasheedja

simplex-method.cabal

@@ -27,25 +27,32 @@ source-repository head
 
 library
   exposed-modules:
-      Linear.Simplex.Constraint.Generic.Types
-      Linear.Simplex.Constraint.Simple.Types
-      Linear.Simplex.Constraint.Simple.Util
-      Linear.Simplex.Constraint.Types
-      Linear.Simplex.Constraint.Util
-      Linear.Simplex.Expr.Types
-      Linear.Simplex.Expr.Util
+      Linear.AugmentedForm.Types
+      Linear.AugmentedForm.Util
+      Linear.Constraint.Generic.Types
+      Linear.Constraint.Linear.Types
+      Linear.Constraint.Simple.Types
+      Linear.Constraint.Simple.Util
+      Linear.Constraint.Standard.Types
+      Linear.Constraint.Types
+      Linear.Constraint.Util
+      Linear.Expr.Types
+      Linear.Expr.Util
       Linear.Simplex.Prettify
       Linear.Simplex.Solver.TwoPhase
-      Linear.Simplex.StandardForm
+      Linear.Simplex.Solver.Types
       Linear.Simplex.Standardize
-      Linear.Simplex.System.Simple.Types
-      Linear.Simplex.System.Simple.Util
-      Linear.Simplex.Term.Types
-      Linear.Simplex.Term.Util
       Linear.Simplex.Types
       Linear.Simplex.Util
-      Linear.Simplex.Var.Types
-      Linear.Simplex.Var.Util
+      Linear.System.Linear.Types
+      Linear.System.Simple.Types
+      Linear.System.Simple.Util
+      Linear.System.Standard.Types
+      Linear.System.Types
+      Linear.Term.Types
+      Linear.Term.Util
+      Linear.Var.Types
+      Linear.Var.Util
   other-modules:
       Paths_simplex_method
   hs-source-dirs:
@@ -68,11 +75,12 @@ test-suite simplex-method-test
   type: exitcode-stdio-1.0
   main-is: Spec.hs
   other-modules:
-      Linear.Simplex.Constraint.Simple.TypesSpec
-      Linear.Simplex.Expr.TypesSpec
-      Linear.Simplex.StandardFormSpec
-      Linear.Simplex.System.Simple.TypesSpec
-      Linear.Simplex.Term.TypesSpec
+      Linear.AugmentedForm.UtilSpec
+      Linear.Constraint.Simple.TypesSpec
+      Linear.Expr.TypesSpec
+      Linear.System.Simple.TypesSpec
+      Linear.Term.TypesSpec
+      Linear.Var.UtilSpec
       TestUtil
       Paths_simplex_method
   hs-source-dirs:

src/Linear/AugmentedForm/Types.hs

@@ -0,0 +1,24 @@
+-- |
+-- Module: Linear.Simplex.AugmentedForm.Types
+-- Description: Types for augmented (slack) form of linear programming problems
+-- Copyright: (c) Junaid Rasheed, 2024
+-- License: BSD-3
+-- Maintainer: Junaid Rasheed <jrasheed178@gmail.com>
+-- Stability: experimental
+module Linear.AugmentedForm.Types where
+
+import GHC.Generics (Generic)
+import Linear.Expr.Types (Expr)
+import Linear.System.Linear.Types (LinearSystem)
+import Linear.Var.Types (SimplexNum, Var)
+
+-- Expr == SimplexNum
+data AugmentedForm = AugmentedForm
+  { maxObjective :: Expr -- TODO: should be no consts
+  , constraints :: LinearSystem
+  , vars :: [Var] -- all vars are non-negative
+  }
+  deriving (Show, Eq, Read, Generic)
+
+class CanBeAugmentedForm a where
+  toAugmentedForm :: a -> AugmentedForm

src/Linear/Simplex/StandardForm.hs renamed to src/Linear/AugmentedForm/Util.hs

@@ -5,25 +5,25 @@
 -- License: BSD-3
 -- Maintainer: Junaid Rasheed <jrasheed178@gmail.com>
 -- Stability: experimental
-module Linear.Simplex.StandardForm where
+module Linear.AugmentedForm.Util where
 
 import qualified Data.Map as Map
-import Linear.Simplex.Constraint.Generic.Types
+import Linear.Constraint.Generic.Types
   ( GenericConstraint ((:<=), (:==), (:>=))
   )
-import Linear.Simplex.Constraint.Simple.Util
+import Linear.Constraint.Simple.Util
   ( substVarSimpleConstraint
   )
-import Linear.Simplex.Expr.Types (Expr (..))
-import Linear.Simplex.System.Simple.Types
+import Linear.Expr.Types (Expr (..))
+import Linear.System.Simple.Types
   ( SimpleSystem
   , findHighestVar
   , simplifySimpleSystem
   )
-import Linear.Simplex.Term.Types
+import Linear.Term.Types
   ( Term (CoeffTerm, ConstTerm, VarTerm)
   )
-import Linear.Simplex.Var.Types (Bounds (Bounds), Var, VarBounds)
+import Linear.Var.Types (Bounds (Bounds), Var, VarBounds)
 
 -- | Eliminate non-zero lower bounds via substitution
 -- Return the system with the eliminated variables and a map of the eliminated variables to their equivalent expressions

src/Linear/Simplex/Constraint/Generic/Types.hs renamed to src/Linear/Constraint/Generic/Types.hs

@@ -1,11 +1,11 @@
 -- |
--- Module      : Linear.Simplex.Constraint.Generic.Types
+-- Module      : Linear.Constraint.Generic.Types
 -- Description : Types for constraints in linear programming problems
 -- Copyright   : (c) Junaid Rasheed, 2020-2024
 -- License     : BSD-3
 -- Maintainer  : jrasheed178@gmail.com
 -- Stability   : experimental
-module Linear.Simplex.Constraint.Generic.Types where
+module Linear.Constraint.Generic.Types where
 
 import Control.Applicative (liftA2)
 import GHC.Generics (Generic)

src/Linear/Constraint/Linear/Types.hs

@@ -0,0 +1,25 @@
+-- |
+-- Description: Types for linear constraints.
+-- Copyright:   (c) Junaid Rasheed, 2024
+-- License:     BSD-3
+-- Maintainer:  Junaid Rasheed <jrasheed178@gmail.com>
+-- Stability:   experimental
+module Linear.Constraint.Linear.Types where
+
+import GHC.Generics (Generic)
+import Linear.Expr.Types
+import Linear.Var.Types
+
+data LinearEquation = LinearEquation
+  { lhs :: Expr
+  , rhs :: SimplexNum
+  }
+  deriving (Show, Eq, Read, Generic)
+
+-- class CanBeLinearEquation a where
+--   toLinearEquation :: a -> LinearEquation
+--   fromLinearEquation :: LinearEquation -> a
+
+-- instance CanBeLinearEquation LinearEquation where
+--   toLinearEquation = id
+--   fromLinearEquation = id

src/Linear/Simplex/Constraint/Simple/Types.hs renamed to src/Linear/Constraint/Simple/Types.hs

@@ -1,15 +1,15 @@
 -- |
--- Module:      Linear.Simplex.Constraint.Simple.Types
+-- Module:      Linear.Constraint.Simple.Types
 -- Description: Types for simple linear constraints
 -- Copyright:   (c) Junaid Rasheed, 2020-2024
 -- License:     BSD-3
 -- Maintainer:  jrasheed178@gmail.com
 -- Stability:   experimental
-module Linear.Simplex.Constraint.Simple.Types where
+module Linear.Constraint.Simple.Types where
 
-import Linear.Simplex.Constraint.Generic.Types
-import Linear.Simplex.Expr.Types
-import Linear.Simplex.Var.Types
+import Linear.Constraint.Generic.Types
+import Linear.Expr.Types
+import Linear.Var.Types
 
 -- data TermsOnlyVars = VarTerm' Var | CoeffTerm' SimplexNum Var
 --   deriving (Show, Read, Eq, Generic)

src/Linear/Simplex/Constraint/Simple/Util.hs renamed to src/Linear/Constraint/Simple/Util.hs

@@ -1,21 +1,21 @@
 -- |
--- Module: Linear.Simplex.Constraint.Simple.Util
+-- Module: Linear.Constraint.Simple.Util
 -- Description: Utility functions for simple constraints
 -- Copyright: (c) Junaid Rasheed, 2020-2024
 -- License: BSD-3
 -- Maintainer: jrasheed178@gmail.com
 -- Stability: experimental
-module Linear.Simplex.Constraint.Simple.Util where
+module Linear.Constraint.Simple.Util where
 
 import qualified Data.List as L
 import qualified Data.Set as Set
-import Linear.Simplex.Constraint.Generic.Types
-import Linear.Simplex.Constraint.Simple.Types
-import Linear.Simplex.Constraint.Types
-import Linear.Simplex.Expr.Types
-import Linear.Simplex.Expr.Util
-import Linear.Simplex.Term.Types
-import Linear.Simplex.Var.Types
+import Linear.Constraint.Generic.Types
+import Linear.Constraint.Simple.Types
+import Linear.Constraint.Types
+import Linear.Expr.Types
+import Linear.Expr.Util
+import Linear.Var.Types
+import Linear.Term.Types
 
 substVarSimpleConstraint :: Var -> Expr -> SimpleConstraint -> SimpleConstraint
 substVarSimpleConstraint var varReplacement (a :<= b) = substVarExpr var varReplacement a :<= b

src/Linear/Constraint/Standard/Types.hs

@@ -0,0 +1,17 @@
+-- |
+-- Module: Linear.Constraint.Standard.Types
+-- Description: Types for linear constraints in standard form
+-- Copyright: (c) Junaid Rasheed, 2024
+-- License: BSD-3
+-- Maintainer: Junaid Rasheed <jrasheed178@gmail.com>
+-- Stability: experimental
+module Linear.Constraint.Standard.Types where
+
+import GHC.Generics (Generic)
+
+-- lhs <= rhs
+data StandardConstraint = StandardConstraint
+  { lhs :: Expr
+  , rhs :: SimplexNum
+  }
+  deriving (Show, Eq, Read, Generic)

src/Linear/Simplex/Constraint/Types.hs renamed to src/Linear/Constraint/Types.hs

@@ -1,17 +1,17 @@
 -- |
--- Module:      Linear.Simplex.Constraint.Types
+-- Module:      Linear.Constraint.Types
 -- Description: Types for linear constraints
 -- Copyright:   (c) Junaid Rasheed, 2020-2024
 -- License:     BSD-3
 -- Maintainer:  jrasheed178@gmail.com
 -- Stability:   experimental
-module Linear.Simplex.Constraint.Types where
+module Linear.Constraint.Types where
 
 import qualified Data.Set as Set
 import GHC.Generics (Generic)
-import Linear.Simplex.Constraint.Generic.Types
-import Linear.Simplex.Expr.Types
-import Linear.Simplex.Var.Types
+import Linear.Constraint.Generic.Types
+import Linear.Expr.Types
+import Linear.Var.Types
 
 -- Input
 type Constraint = GenericConstraint Expr Expr

src/Linear/Simplex/Constraint/Util.hs renamed to src/Linear/Constraint/Util.hs

@@ -1,18 +1,18 @@
 -- |
--- Module:      Linear.Simplex.Constraint.Util
+-- Module:      Linear.Constraint.Util
 -- Description: Utility functions for constraints
 -- Copyright:   (c) Junaid Rasheed, 2020-2024
 -- License:     BSD-3
 -- Maintainer:  jrasheed178@gmail.com
 -- Stability:   experimental
-module Linear.Simplex.Constraint.Util where
+module Linear.Constraint.Util where
 
 import qualified Data.Set as Set
-import Linear.Simplex.Constraint.Generic.Types
-import Linear.Simplex.Constraint.Types
-import Linear.Simplex.Expr.Types
-import Linear.Simplex.Expr.Util
-import Linear.Simplex.Var.Types
+import Linear.Constraint.Generic.Types
+import Linear.Constraint.Types
+import Linear.Expr.Types
+import Linear.Expr.Util
+import Linear.Var.Types
 
 constraintVars :: Constraint -> Set.Set Var
 constraintVars (lhs :<= rhs) = exprVars lhs <> exprVars rhs