gspl

gspl

gspl (short for Go Simplex Programming Library, pronounced gospel) is a lightweight solver for linear programming problems, built in Go using the revised simplex method. It emphasizes clarity, performance, and seamless integration into Go applications.

Features

• Solves optimal, unbounded, infeasible, and degenerate linear problems.
• Implements an efficient revised simplex algorithm.
• Clean and idiomatic API for modeling and solving LPs.
• Focused on numerical stability and usability.

gspl is ideal for embedding linear optimization into Go-based software.

Installation

Ensure you have Go installed, then run:

go get github.com/chriso345/gspl

Usage

Here's how to define and solve a basic linear programming problem with gspl:

package main

import (
	"github.com/chriso345/gspl/lp"
	"github.com/chriso345/gspl/solver"
)

func main() {
	// Create decision variables
	variables := []lp.LpVariable{
		lp.NewVariable("x1"),
		lp.NewVariable("x2"),
		lp.NewVariable("x3"),
	}

	x1 := &variables[0]
	x2 := &variables[1]
	x3 := &variables[2]

	// Objective function: Minimize -6 * x1 + 7 * x2 + 4 * x3
	objective := lp.NewExpression([]lp.LpTerm{
		lp.NewTerm(-6, *x1),
		lp.NewTerm(7, *x2),
		lp.NewTerm(4, *x3),
	})

	// Set up the LP problem
	example := lp.NewLinearProgram("README Example", variables)
	example.AddObjective(lp.LpMinimise, objective)

	// Add constraints
	example.AddConstraint(lp.NewExpression([]lp.LpTerm{
		lp.NewTerm(2, *x1),
		lp.NewTerm(5, *x2),
		lp.NewTerm(-1, *x3),
	}), lp.LpConstraintLE, 18)

	example.AddConstraint(lp.NewExpression([]lp.LpTerm{
		lp.NewTerm(1, *x1),
		lp.NewTerm(-1, *x2),
		lp.NewTerm(-2, *x3),
	}), lp.LpConstraintLE, -14)

	example.AddConstraint(lp.NewExpression([]lp.LpTerm{
		lp.NewTerm(3, *x1),
		lp.NewTerm(2, *x2),
		lp.NewTerm(2, *x3),
	}), lp.LpConstraintEQ, 26)

	// Solve it
	solver.Solve(&example).PrintSolution()
}

What’s Happening?

We’re setting up a linear program to:

1. Minimize: $-6x_1 + 7x_2 + 4x_3$

2. Subject to constraints:

   • $2x_1 + 5x_2 - x_3 \leq 18$
   • $x_1 - x_2 - 2x_3 \leq -14$
   • $3x_1 + 2x_2 + 2x_3 = 26$

The solution will print the optimal values of the variables and the minimized objective value.

See the examples directory for other scenarios.

API Overview

Variables

Create decision variables as a slice:

variables := []lp.LpVariable{
    lp.NewVariable("x1"),
    lp.NewVariable("x2"),
}

You can access and pass them as pointers:

x1 := &variables[0]

Objective Function

Build the objective using terms:

objective := lp.NewExpression([]lp.LpTerm{
    lp.NewTerm(5, *x1),
    lp.NewTerm(3, *x2),
})

Add it to the LP:

lp := lp.NewLinearProgram("My LP", variables)
lp.AddObjective(lp.LpMaximise, objective)

Constraints

Each constraint uses an expression, a comparison type, and a right-hand side:

lp.AddConstraint(lp.NewExpression([]lp.LpTerm{
    lp.NewTerm(2, *x1),
    lp.NewTerm(3, *x2),
}), lp.LpConstraintLE, 10)

Constraint types:

• gspl.LpConstraintLE - less than or equal
• gspl.LpConstraintGE - greater than or equal
• gspl.LpConstraintEQ - equality

Solving

solution := solver.Solve(&lp)
solution.PrintSolution()

This solves the model and prints variable values and the objective result.

License

Licensed under the MIT License. See the LICENSE file for more details.