lpsolver 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a24185adf2e045f36f5249e311b5d357ca16134ab259c4f350fddbe07e141d9c
-  data.tar.gz: 9fb91dbea34b972e32876b97b4719ef771b30b8975d9ec5bf7494a4d7d49b2d7
+  metadata.gz: 92ca955854e8330a4c7bc4000076d0a4e1b6c2828507b1bbaae1cdc4168a80b1
+  data.tar.gz: 20993564cfc5e75be002b3a558b6a3cab49136a96f73e693cdfb7e1791f51c71
 SHA512:
-  metadata.gz: b64322ff1240d58b92345ce8e9fff552dceeada28d57066fc56a94c02a89f66debaeeb1ccc3e37fbb434fe6619b828f91f536a5f8abc323d2792c8f8da37e4c9
-  data.tar.gz: fe8f3fba95166b9608837886d84b81adfa4d9b1416864c3607a5f194d9aaa679d36af36389ec1e6db4dc239e7d64417bd9b985a3a1a300c3c35f75597a950988
+  metadata.gz: c61c459e3a47afc69fe0090aca6979ff4079cf73a4b17216594888babafba706511e115c59c4d23b7f14ff511cde0778f7e7557c716b31246fafc4b8d17431a2
+  data.tar.gz: bcc475ef900fab92a6c21696d2de870cc78e2890df0c35529385a68d3d80e0b7a1c908828e5806a80fbddc786277f4bb5db6502c530f3e210a48aaea3b4b00f9

data/README.md

@@ -1,7 +1,11 @@
 # LpSolver
 
+[![test](https://github.com/davidsiaw/lpsolver/actions/workflows/test.yml/badge.svg)](https://github.com/davidsiaw/lpsolver/actions/workflows/test.yml)
+
 A Ruby gem for solving optimization problems using the [HiGHS](https://github.com/ERGO-Code/HiGHS) solver.
 
+Reference documentation can be found at https://davidsiaw.github.io/lpsolver/
+
 ## What is this for?
 
 Imagine you want to **maximize profit** or **minimize cost** while following certain rules (like a budget limit or a minimum requirement). This gem helps you find the best answer.
@@ -190,6 +194,32 @@ solution = model.maximize!(x * 3 + y * 5)
 puts solution.objective_value  # => 50.0
 ```
 
+### Infeasible and Unbounded Solutions
+
+Not all problems have a valid solution. Always check the status before accessing values:
+
+```ruby
+model = LpSolver::Model.new
+x = model.add_variable(:x, lb: 0)
+y = model.add_variable(:y, lb: 0)
+
+# Contradictory constraints — no solution exists
+model.add_constraint(:c1, (x + y) <= 2)
+model.add_constraint(:c2, (x + y) >= 5)
+
+solution = model.minimize!(x + y)
+
+if solution.infeasible?
+  puts "No feasible solution exists"
+elsif solution.unbounded?
+  puts "The objective can grow without limit"
+else
+  puts "Optimal value: #{solution.objective_value}"
+end
+```
+
+> **Important:** When a solution is infeasible, `objective_value` returns `0.0` and `variables` is empty. Always call `solution.infeasible?` or `solution.unbounded?` first before reading `objective_value` or variable values.
+
 ### Complex Expressions
 
 You can chain operators with constants and unary minus:
@@ -387,3 +417,7 @@ True if the objective can improve without limit.
 ## Code of Conduct
 
 See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+
+# Disclaimer
+
+Note that this is vibe-coded in nearly its entirety as part of a quick experiment to improve tokens per sec on my local machine and I do not recommend it for use in any sensitive environments. Note that I do not accept any responsibility for any damages or losses caused by the use of this gem, and I still expect contributed PRs to be provided in sensible and human-reviewable doses.

data/ext/lpsolver/Makefile

@@ -13,12 +13,12 @@ NULLCMD = :
 #### Start of system configuration section. ####
 
 srcdir = .
-topdir = /usr/local/include/ruby-3.4.0
+topdir = /home/node/.rvm/rubies/ruby-3.3.7/include/ruby-3.3.0
 hdrdir = $(topdir)
-arch_hdrdir = /usr/local/include/ruby-3.4.0/x86_64-linux
+arch_hdrdir = /home/node/.rvm/rubies/ruby-3.3.7/include/ruby-3.3.0/x86_64-linux
 PATH_SEPARATOR = :
 VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
-prefix = $(DESTDIR)/usr/local
+prefix = $(DESTDIR)/home/node/.rvm/rubies/ruby-3.3.7
 rubysitearchprefix = $(rubylibprefix)/$(sitearch)
 rubyarchprefix = $(rubylibprefix)/$(arch)
 rubylibprefix = $(libdir)/$(RUBY_BASE_NAME)
@@ -42,7 +42,6 @@ archincludedir = $(includedir)/$(arch)
 sitearchlibdir = $(libdir)/$(sitearch)
 archlibdir = $(libdir)/$(arch)
 ridir = $(datarootdir)/$(RI_BASE_NAME)
-modular_gc_dir = $(DESTDIR)
 mandir = $(datarootdir)/man
 localedir = $(datarootdir)/locale
 libdir = $(exec_prefix)/lib
@@ -79,7 +78,7 @@ COUTFLAG = -o $(empty)
 CSRCFLAG = $(empty)
 
 RUBY_EXTCONF_H = 
-cflags   = $(hardenflags)  $(optflags) $(debugflags) $(warnflags)
+cflags   = $(optflags) $(debugflags) $(warnflags)
 cxxflags = 
 optflags = -O3 -fno-fast-math
 debugflags = -ggdb3
@@ -87,19 +86,17 @@ warnflags = -Wall -Wextra -Wdeprecated-declarations -Wdiv-by-zero -Wduplicated-c
 cppflags = 
 CCDLFLAGS = -fPIC
 CFLAGS   = $(CCDLFLAGS) $(cflags)  -fPIC $(ARCH_FLAG)
-INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) -I/home/david/programs/ai/pi/workspace/lpsolver/ext/lpsolver-highs/highs -I/home/david/programs/ai/pi/workspace/lpsolver/ext/lpsolver-highs/build/include/highs
+INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) -I/workspace/lpsolver/ext/lpsolver-highs/highs -I/workspace/lpsolver/ext/lpsolver-highs/build/include/highs
 DEFS     = 
 CPPFLAGS =   $(DEFS) $(cppflags)
 CXXFLAGS = $(CCDLFLAGS)  $(ARCH_FLAG)
-ldflags  = -L. -fstack-protector-strong -rdynamic -Wl,-export-dynamic -Wl,--no-as-needed -L/home/david/programs/ai/pi/workspace/lpsolver/ext/lpsolver-highs/build/lib -Wl,-rpath,/home/david/programs/ai/pi/workspace/lpsolver/ext/lpsolver-highs/build/lib
+ldflags  = -L. -fstack-protector-strong -rdynamic -Wl,-export-dynamic -Wl,--no-as-needed -L/workspace/lpsolver/ext/lpsolver-highs/build/lib -Wl,-rpath,/workspace/lpsolver/ext/lpsolver-highs/build/lib
 dldflags = -Wl,--compress-debug-sections=zlib 
 ARCH_FLAG = 
 DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
 LDSHARED = $(CC) -shared
 LDSHAREDXX = $(CXX) -shared
-POSTLINK = :
 AR = gcc-ar
-LD = ld
 EXEEXT = 
 
 RUBY_INSTALL_NAME = $(RUBY_BASE_NAME)
@@ -111,7 +108,7 @@ RUBY_BASE_NAME = ruby
 
 arch = x86_64-linux
 sitearch = $(arch)
-ruby_version = 3.4.0
+ruby_version = 3.3.0
 ruby = $(bindir)/$(RUBY_BASE_NAME)
 RUBY = $(ruby)
 BUILTRUBY = $(bindir)/$(RUBY_BASE_NAME)
@@ -131,7 +128,7 @@ TOUCH = exit >
 
 preload = 
 libpath = . $(libdir)
-LIBPATH = -L. -L$(libdir) -Wl,-rpath,$(libdir)
+LIBPATH =  -L. -L$(libdir) -Wl,-rpath,$(libdir)
 DEFFILE = 
 
 CLEANFILES = mkmf.log
@@ -266,7 +263,6 @@ $(TARGET_SO): $(OBJS) Makefile
 	$(ECHO) linking shared-object lpsolver/$(DLLIB)
 	-$(Q)$(RM) $(@)
 	$(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
-	$(Q) $(POSTLINK)
 
 
 

data/lib/lpsolver/model.rb

@@ -264,12 +264,16 @@ module LpSolver
             "--solution_file #{solution_file.path}"
 
       output = `#{cmd} 2>&1`
-      status = $?.success?
-
       lp_file.unlink
       opts_file.unlink
 
-      raise SolverError, "HiGHS solver failed:\n#{output}" unless status
+      # HiGHS returns non-zero exit code for infeasible/unbounded problems,
+      # but still writes a valid solution file. Check for valid status instead.
+      solution_content = File.read(solution_file.path)
+      status_match = solution_content.match(/Model status\s*\n\s*(\S+)/i)
+      unless status_match
+        raise SolverError, "HiGHS solver failed:\n#{output}" unless $?.success?
+      end
 
       @solution = parse_solution_file(solution_file.path)
       solution_file.unlink

data/lib/lpsolver/solution.rb

@@ -21,11 +21,15 @@ module LpSolver
     # @return [Hash{String => Float}] Maps variable names to their optimal values.
     #   The keys are the variable names as strings (as produced by HiGHS),
     #   and the values are the optimal decision variable values.
+    #   When the solution is infeasible, this hash is empty.
+    #   Always check `infeasible?` or `unbounded?` before reading variable values.
     attr_reader :variables
 
     # @return [Float] The optimal objective function value.
     #   For minimization problems, this is the minimum value.
     #   For maximization problems, this is the maximum value.
+    #   When the solution is infeasible, this returns `0.0`.
+    #   Always check `infeasible?` or `unbounded?` before reading this value.
     attr_reader :objective_value
 
     # @return [String] The status of the model as reported by HiGHS.
@@ -40,6 +44,19 @@ module LpSolver
     #   This is a diagnostic metric; may be 0 for some solver types.
     attr_reader :iterations
 
+    # Returns the model status as a Symbol.
+    #
+    # @return [Symbol] The solver status as a Ruby symbol:
+    #   - :optimal — An optimal solution was found.
+    #   - :infeasible — No feasible solution exists.
+    #   - :unbounded — The objective can be improved without bound.
+    #   - :unknown — The solver could not determine the status.
+    # @example
+    #   solution.status  # => :optimal
+    def status
+      @model_status.to_sym
+    end
+
     # Creates a new Solution object.
     #
     # @param variables [Hash{String => Float}] Maps variable names to values.
@@ -57,12 +74,15 @@ module LpSolver
     #
     # @param name [Symbol, String, Variable] The variable name (Symbol, String,
     #   or Variable object).
-    # @return [Float] The optimal value of the variable.
+    # @return [Float] The optimal value of the variable, or `nil` if the
+    #   solution is infeasible or unbounded.
     # @raise [KeyError] If the variable name is not found in the solution.
     # @example
     #   solution[:x]        # => 4.0 (by symbol)
     #   solution['x']       # => 4.0 (by string)
     #   solution[x]         # => 4.0 (by Variable object)
+    # @note When the solution is infeasible, all variables are empty.
+    #   Check `infeasible?` first before accessing variable values.
     def [](name)
       key = if name.is_a?(Variable)
         name.name.to_s

data/lib/lpsolver/version.rb

@@ -4,5 +4,5 @@ module LpSolver
   # The current version of the LpSolver gem.
   #
   # @return [String] The version string (e.g., "0.1.0").
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lpsolver
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Siaw