lpsolve 5.5.10.i

data/doc/run_doxygen

@@ -0,0 +1,107 @@
+#!/bin/sh
+# $Id: run_doxygen,v 1.1 2003/11/09 14:11:02 rocky Exp $
+
+# Runs doxygen and massages the output files.
+# Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
+#
+# Synopsis:  run_doxygen --mode=[user|maint|man]  v3srcdir  v3builddir
+#
+# Originally hacked together by Phil Edwards <pme@gcc.gnu.org>
+
+
+# We can check now that the version of doxygen is >= this variable.
+DOXYVER=1.2.15
+doxygen=
+
+find_doxygen() {
+    v_required=`echo $DOXYVER |  \
+                awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
+    testing_version=
+    # thank you goat book
+    set `IFS=:; X="$PATH:/usr/local/bin:/bin:/usr/bin"; echo $X`
+    for dir
+    do
+      # AC_EXEEXT could come in useful here
+      maybedoxy="$dir/doxygen"
+      test -f "$maybedoxy" && testing_version=`$maybedoxy --version`
+      if test -n "$testing_version"; then
+       v_found=`echo $testing_version |  \
+                awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
+       if test $v_found -ge $v_required; then
+         doxygen="$maybedoxy"
+         break
+       fi
+      fi
+    done
+    if test -z "$doxygen"; then
+        echo run_doxygen error:  Could not find Doxygen $DOXYVER in path. 1>&2
+        print_usage
+    fi
+}
+
+print_usage() {
+    cat 1>&2 <<EOF
+Usage:  run_doxygen --mode=MODE [<options>] <v3-src-dir> <v3-build-dir>
+      MODE is one of:
+          user           Generate user-level HTML library documentation.
+          maint          Generate maintainers' HTML documentation (lots more;
+                             exposes non-public members, etc).
+          man            Generate user-level man pages.
+
+      more options when i think of them
+
+Note:  Requires Doxygen ${DOXYVER} or later; get it at
+       ftp://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYVER}.src.tar.gz
+
+EOF
+    exit 1
+}
+
+parse_options() {
+  for o
+  do
+    # Blatantly ripped from autoconf, er, I mean, "gratefully standing
+    # on the shoulders of those giants who have gone before us."
+    case "$o" in
+      -*=*) arg=`echo "$o" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
+      *) arg= ;;
+    esac
+
+    case "$o" in
+      --mode=*)
+        mode=$arg ;;
+      --mode | --help | -h)
+        print_usage ;;
+      *)
+        # this turned out to be a mess, maybe change to --srcdir=, etc
+        if test $srcdir = unset; then
+          srcdir=$o
+        elif test $outdir = unset; then
+          builddir=${o}
+          outdir=${o}/doc/doxygen
+        else
+          echo run_doxygen error:  Too many arguments 1>&2
+          exit 1
+        fi
+        ;;
+      esac
+  done
+}
+
+
+# script begins here
+mode=unset
+srcdir=unset
+outdir=unset
+do_html=no
+do_man=no
+enabled_sections=
+DATEtext=`date '+%Y-%m-%d'`
+
+parse_options $*
+find_doxygen
+$doxygen ./Doxyfile
+
+exit 0
+
+# vim:ts=4:et:

data/doc/typos.txt

@@ -0,0 +1,29 @@
+print routine: don't show 0's in as coefficients. Show SOS sets
+Don't show anything if no columns. 
+
+Automatically adjust width of 1st column, row names, based on the
+width of the longest row name.
+
+is_debug:
+---------
+mend -> meant.
+
+get_solutioncount
+algoritm -> algorithm
+
+SOS.html:
+---------
+
+In SOS example 
+
+  sos
+  SOS: x1,x2,x3,x4,x5 <= 2;
+
+Can't deal with <=2. Use instead:
+
+  sos2
+  sos: x1,x2,x3,x4,x5;
+ 
+is_SOS_var:
+----------
+   Small wording things. should for must.

data/example/boilerplate.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+Mypath  = File.expand_path(File.dirname(__FILE__))
+old_dir = File.expand_path(Dir.pwd)
+if old_dir != Mypath
+  Dir.chdir(Mypath)
+end
+$: << Mypath + '/../ext'
+require "lpsolve"

data/example/demo.rb

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby
+# $Id: demo.rb,v 1.7 2007/03/28 02:11:59 rocky Exp $
+require "rubygems"
+require 'highline/import'
+
+Mypath  = File.expand_path(File.dirname(__FILE__))
+old_dir = File.expand_path(Dir.pwd)
+if old_dir != Mypath
+  Dir.chdir(Mypath)
+end
+$: << Mypath + '/../ext'
+require "lpsolve"
+
+def press_ret
+  ask("[return]") { |q| q.echo = true }
+end
+
+def error() 
+  STDERR.print "Error\n"
+  exit 1
+end
+
+lp = LPSolve.new(0, 4)
+
+Vers=lp.version
+Vers_str = "%d.%d.%d.%d" % Vers
+puts "lp_solve %s demo\n\n" % Vers_str
+
+if not lp
+  error
+end
+
+puts "This demo will show most of the features of lp_solve %s" % Vers_str
+press_ret
+puts "We start by creating a new problem with 4 variables and 0 constraints"
+puts "We use: lp=make_lp(0,4);"
+press_ret
+
+puts "We can show the current problem with print_lp(lp)"
+lp.print_lp
+press_ret
+
+puts "Now we add some constraints"
+puts "str_add_constraint(lp, \"3 2 2 1\" ,LE,4)"
+puts "This is the string version of add_constraint. For the normal version"
+puts "of add_constraint see the help file"
+
+if not lp.str_add_constraint("3 2 2 1", LPSolve::LE, 4)
+  puts "Error in adding constraint"
+  error
+end
+
+lp.print_lp()
+press_ret
+
+puts "str_add_constraint(lp, \"0 4 3 1\" ,GE,3)"
+if not lp.str_add_constraint("0 4 3 1", LPSolve::GE, 3)
+  puts "Error in adding constraint"
+  error
+end
+lp.print_lp()
+press_ret
+
+puts "Set the objective function"
+puts "str_set_obj_fn(lp, \"2 3 -2 3\")"
+if not lp.str_set_obj_fn("2 3 -2 3")
+  puts "Error in setting objective function"
+  error
+end
+lp.print_lp()
+press_ret
+
+puts "Now solve the problem with printf(solve(lp));"
+solution = lp.solve
+puts "%d" % solution
+press_ret
+
+puts "The value is 0, this means we found an optimal solution"
+puts "We can display this solution with print_objective(lp) and print_solution(lp)"
+
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+
+puts "The dual variables of the solution are printed with"
+puts "print_duals(lp);"
+lp.print_duals()
+press_ret
+
+puts "We can change a single element in the matrix with"
+puts "set_mat(lp,2,1,0.5)"
+
+if (!lp.set_mat(2,1,0.5))
+  error
+end  
+  
+lp.print_lp
+press_ret
+puts "If we want to maximize the objective function use set_maxim(lp);"
+lp.set_maxim
+lp.print_lp
+press_ret
+puts  "after solving this gives us:\n"
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+lp.print_duals
+press_ret
+puts "Change the value of a rhs element with set_rh(lp,1,7.45)"
+lp.set_rh(1,7.45)
+lp.print_lp
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+puts "We change %s to the integer type with" % lp.get_col_name(4)
+puts "set_int(lp, 4, TRUE)"
+lp.set_int(4, true)
+lp.print_lp
+puts "We set branch & bound debugging on with set_debug(lp, TRUE)"
+lp.set_debug(true)
+puts "and solve..."
+press_ret()
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret()
+puts "We can set bounds on the variables with"
+puts "set_lowbo(lp,2,2); & set_upbo(lp,4,5.3)"
+lp.set_lowbo(2,2)
+lp.set_upbo(4,5.3)
+lp.print_lp
+press_ret
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+puts "Now remove a constraint with del_constraint(lp, 1)"
+lp.del_constraint(1)
+lp.print_lp
+puts ("Add an equality constraint")
+if not lp.str_add_constraint("1 2 1 4", LPSolve::EQ, 8)
+    error()
+end
+lp.print_lp
+press_ret
+printf("A column can be added with:\n")
+printf("str_add_column(lp,\"3 2 2\");\n")
+if (not lp.str_add_column("3 2 2"))
+  error
+end
+lp.print_lp
+press_ret
+printf("A column can be removed with:\n");
+printf("del_column(lp,3);\n");
+lp.del_column(3)
+lp.print_lp
+press_ret
+printf("We can use automatic scaling with:\n")
+printf("set_scaling(lp, SCALE_MEAN);\n")
+lp.set_scaling(LPSolve::SCALE_MEAN)
+lp.print_lp
+press_ret
+
+printf("The function get_mat(lprec *lp, int row, int column) returns a single\n");
+printf("matrix element\n");
+printf("%s get_mat(lp,2,3), get_mat(lp,1,1); gives\n","printf(\"%f %f\\n\",");
+printf("%f %f\n", lp.get_mat(2,3), lp.get_mat(1,1));
+printf("Notice that get_mat returns the value of the original unscaled problem\n");
+press_ret();
+printf("If there are any integer type variables, then only the rows are scaled\n");
+printf("set_int(lp,3,FALSE);\n");
+printf("set_scaling(lp, SCALE_MEAN);\n");
+lp.set_scaling(LPSolve::SCALE_MEAN);
+lp.set_int(3,FALSE);
+lp.print_lp
+press_ret
+lp.solve
+printf("print_objective, print_solution gives the solution to the original problem\n");
+lp.print_objective
+lp.print_solution(1);
+lp.print_constraints(1);
+press_ret
+
+printf("Scaling is turned off with unscale(lp);\n");
+lp.unscale;
+lp.print_lp
+press_ret();
+printf("Now turn B&B debugging off and simplex tracing on with\n");
+printf("set_debug(lp, FALSE), set_trace(lp, TRUE) and solve(lp)\n");
+lp.set_debug(FALSE);
+lp.set_trace(TRUE);
+press_ret();
+lp.solve
+
+printf("Where possible, lp_solve will start at the last found basis\n");
+printf("We can reset the problem to the initial basis with\n");
+printf("default_basis(lp). Now solve it again...\n");
+press_ret();
+lp.default_basis
+lp.solve
+
+printf("It is possible to give variables and constraints names\n");
+printf("set_row_name(lp,1,\"speed\"); & set_col_name(lp,2,\"money\")\n");
+if (not lp.set_row_name(1,"speed"))
+    error();
+end
+if (!lp.set_col_name(2,"money"))
+  error();
+end  
+lp.print_lp
+printf("As you can see, all column and rows are assigned default names\n");
+printf("If a column or constraint is deleted, the names shift place also:\n");
+press_ret();
+printf("del_column(lp,1);\n");
+lp.del_column(1);
+lp.print_lp
+press_ret();

data/example/lp.lp

@@ -0,0 +1,9 @@
+/* Objective function */
+Maximize: +3 money +3 C3 +3 C4;
+
+speed: +4 money +C3 +2 C4 >= 3;
++2 money +4 C3 +2 C4 = 8;
+
+/* Variable bounds */
+money >= 2;
+C3 <= 5.3;

data/example/lp.mps

@@ -0,0 +1,25 @@
+*<meta creator='lp_solve v5.5'>
+*<meta rows=2>
+*<meta columns=3>
+*<meta equalities=1>
+*<meta integers=0>
+*<meta origsense='MAX'>
+*
+NAME                  
+ROWS
+ N  R0      
+ G  speed   
+ E  R2      
+COLUMNS
+    money     R0        -3.000000000   speed     4.0000000000
+    money     R2        2.0000000000
+    C3        R0        -3.000000000   speed     1.0000000000
+    C3        R2        4.0000000000
+    C4        R0        -3.000000000   speed     2.0000000000
+    C4        R2        2.0000000000
+RHS
+    RHS       speed     3.0000000000   R2        8.0000000000
+BOUNDS
+ LO BND       money     2.0000000000
+ UP BND       C3        5.3000000000
+ENDATA

data/example/model.lp

@@ -0,0 +1,8 @@
+/* model.lp */
+
+max: 143 x + 60 y;
+
+120 x + 210 y <= 15000;
+110 x + 30 y <= 4000;
+x + y <= 75;
+

data/example/model.mps

@@ -0,0 +1,16 @@
+* model.mps
+NAME
+ROWS
+ N  R0
+ L  R1
+ L  R2
+ L  R3
+COLUMNS
+    x         R0        143.00000000   R1        120.00000000
+    x         R2        110.00000000   R3        1.0000000000
+    y         R0        60.00000000    R1        210.00000000
+    y         R2        30.000000000   R3        1.0000000000
+RHS
+    RHS       R1        15000.000000   R2        4000.0000000
+    RHS       R3        75.000000000
+ENDATA

data/example/rubydemo.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env ruby
+# $Id: demo.rb,v 1.7 2007/03/28 02:11:59 rocky Exp $
+require "rubygems"
+require 'highline/import'
+
+Mypath  = File.expand_path(File.dirname(__FILE__))
+old_dir = File.expand_path(Dir.pwd)
+if old_dir != Mypath
+  Dir.chdir(Mypath)
+end
+$: << Mypath + '/../ext'
+require "lpsolve"
+
+def press_ret
+  ask("[return]") { |q| q.echo = true }
+end
+
+def error() 
+  STDERR.print "Error\n"
+  exit 1
+end
+
+Vers=LPsolve::version
+Vers_str = "%d.%d.%d.%d" % Vers
+puts "lp_solve %s demo\n" % Vers_str
+
+puts "This demo will show most of the features of lp_solve %s" % Vers_str
+press_ret
+puts "We start by creating a new problem with 4 variables and 0 constraints"
+puts "We use: lp = LPSolve.new(0,4)"
+lp = LPSolve.new(0, 4)
+error if not lp
+press_ret
+
+puts "We can show the current problem with lp.print_lp"
+lp.print_lp
+press_ret
+
+puts "Now we add some constraints"
+puts 'lp.str_add_constraint("3 2 2 1", LPSolve::LE, 4)'
+puts "This is the string version of add_constraint. For the normal version"
+puts "of add_constraint see the help file"
+
+if not lp.str_add_constraint("3 2 2 1", LPSolve::LE, 4)
+  puts "Error in adding constraint"
+  error
+end
+
+lp.print_lp()
+press_ret
+
+puts 'lp.str_add_constraint("0 4 3 1\" ,GE,3)'
+if not lp.str_add_constraint("0 4 3 1", LPSolve::GE, 3)
+  puts "Error in adding constraint"
+  error
+end
+lp.print_lp()
+press_ret
+
+puts "Set the objective function"
+puts 'lp.str_set_obj_fn("2 3 -2 3")'
+if not lp.str_set_obj_fn("2 3 -2 3")
+  puts "Error in setting objective function"
+  error
+end
+lp.print_lp()
+press_ret
+
+puts "Now solve the problem with lp.solve;"
+solution = lp.solve
+puts "%d" % solution
+press_ret
+
+puts "The value is 0, this means we found an optimal solution"
+puts "We can display this solution with lp.print_objective and lp.print_solution"
+
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+
+puts "The dual variables of the solution are printed with"
+puts "lp.print_duals"
+lp.print_duals()
+press_ret
+
+puts "We can change a single element in the matrix with"
+puts "lp.set_mat(2,1,0.5)"
+
+error if not lp.set_mat(2,1,0.5)
+  
+lp.print_lp
+press_ret
+puts "If we want to maximize the objective function use lp.set_maxim"
+lp.set_maxim
+lp.print_lp
+press_ret
+puts  "after solving this gives us:\n"
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+lp.print_duals
+press_ret
+puts "Change the value of a rhs element with set_rh(lp,1,7.45)"
+lp.set_rh(1,7.45)
+lp.print_lp
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+puts "We change %s to the integer type with" % lp.get_col_name(4)
+puts "lp.set_int(4, TRUE)"
+lp.set_int(4, true)
+lp.print_lp
+puts "We set branch & bound debugging on with lp.set_debug(TRUE)"
+lp.set_debug(true)
+puts "and solve..."
+press_ret()
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret()
+puts "We can set bounds on the variables with"
+puts "lp.set_lowbo(2,2); & lp.set_upbo(4,5.3)"
+lp.set_lowbo(2,2)
+lp.set_upbo(4,5.3)
+lp.print_lp
+press_ret
+lp.solve
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+puts "Now remove a constraint with lp.del_constraint(1)"
+lp.del_constraint(1)
+lp.print_lp
+puts ("Add an equality constraint")
+if not lp.str_add_constraint("1 2 1 4", LPSolve::EQ, 8)
+    error()
+end
+lp.print_lp
+press_ret
+puts "A column can be added with:"
+puts 'lp.str_add_column("3 2 2")'
+error if not lp.str_add_column("3 2 2")
+lp.print_lp
+press_ret
+puts "A column can be removed with:"
+puts "del_column(lp,3)"
+lp.del_column(3)
+lp.print_lp
+press_ret
+puts "We can use automatic scaling with:"
+puts "lp.scaling = LPSolve::SCALE_MEAN"
+lp.scaling = LPSolve::SCALE_MEAN
+lp.print_lp
+press_ret
+
+puts "The function lp.get_mat(row, column) returns a single"
+puts "matrix element"
+printf("%s get_mat(lp,2,3), get_mat(lp,1,1); gives\n","printf(\"%f %f\\n\",");
+printf("%f %f\n", lp.get_mat(2,3), lp.get_mat(1,1))
+puts "Notice that get_mat returns the value of the original unscaled problem"
+press_ret
+puts "If there are any integer type variables, then only the rows are scaled"
+puts "lp.set_int(3,FALSE)"
+puts "lp.scaling = LPSolve::SCALE_MEAN"
+lp.scaling = LPSolve::SCALE_MEAN
+lp.set_int(3,FALSE)
+lp.print_lp
+press_ret
+lp.solve
+puts "print_objective, print_solution gives the solution to the original problem"
+lp.print_objective
+lp.print_solution(1)
+lp.print_constraints(1)
+press_ret
+
+puts "Scaling is turned off with lp.unscale;"
+lp.unscale;
+lp.print_lp
+press_ret
+puts "Now turn B&B debugging off and simplex tracing on with"
+puts "lp.debug = FALSE, lp.trace = TRUE) and lp.solve"
+lp.set_debug(FALSE);
+lp.set_trace(TRUE);
+press_ret();
+lp.solve
+
+puts "Where possible, lp_solve will start at the last found basis"
+puts "We can reset the problem to the initial basis with"
+puts "default_basis(lp). Now solve it again..."
+press_ret
+lp.default_basis
+lp.solve
+
+puts "It is possible to give variables and constraints names"
+puts 'lp.set_row_name(1, "speed"); & lp.set_col_name(2,"money")'
+if (not lp.set_row_name(1,"speed"))
+    error();
+end
+if (!lp.set_col_name(2,"money"))
+  error();
+end  
+lp.print_lp
+puts "As you can see, all column and rows are assigned default names"
+puts "If a column or constraint is deleted, the names shift place also:"
+press_ret
+puts "lp.del_column(1)"
+lp.del_column(1)
+lp.print_lp
+press_ret