opl 2.1.0 → 2.2.0

data/lib/opl.rb

@@ -11,13 +11,6 @@ require "rglpk"
 #
 #should return an error message
 
-#2.2
-#a matrix representation of the solution if using
-	#sub notation
-
-#2.3
-#parse data from a file
-
 #2.4
 #way more comprehensive test suite of functionality so far
 
@@ -137,6 +130,41 @@ class Array
 			values_at_a(indices[1..-1], current_array[indices[0]])
 		end
 	end
+
+	def inject_dim(int)
+		arr = self
+		int.times do
+			arr << []
+		end
+		arr
+	end
+
+	def matrix(int_arr, current_arr=[])		
+		int = int_arr[0]
+		new_int_arr = int_arr[1..-1]
+		if int_arr.empty?
+			return(current_arr)
+		else
+			if current_arr.empty?
+				new_arr = current_arr.inject_dim(int)
+				self.matrix(new_int_arr, new_arr)
+			else
+				current_arr.each do |arr|
+					arr.matrix(int_arr, arr)
+				end
+			end
+		end
+	end
+
+	def insert_at(position_arr, value)
+		arr = self
+		if position_arr.size == 1
+			arr[position_arr[0]] = value
+			return(arr)
+		else
+			arr[position_arr[0]].insert_at(position_arr[1..-1], value)
+		end				
+	end
 end
 
 class OPL
@@ -153,18 +181,17 @@ class OPL
 		end
 
 		def self.forall(text)
-			#need to be able to handle sums inside here
 			#in: "i in (0..2), x[i] <= 5"
 			#out: ["x[0] <= 5", "x[1] <= 5", "x[2] <= 5"]
 			text = text.sub_paren_with_array
-			#text = sub_paren_with_array(text)
+			if ((text.gsub(" ","")).scan(/\]\,/).size) + ((text.gsub(" ","")).scan(/\)\,/).size) != text.gsub(" ","").scan(/in/).size
+				raise "The following forall() constraint is incorrectly formatted: #{text}. Please see the examples in test.rb for forall() constraints. I suspect you are missing a comma somewhere."
+			end
 			final_constraints = []
 			indices = text.scan(/[a-z] in/).map{|sc|sc[0]}
 			values = text.scan(/\s\[[\-\s\d+,]+\]/).map{|e|e.gsub(" ", "").scan(/[\-\d]+/)}
 			index_value_pairs = indices.zip(values)
 			variable = text.scan(/[a-z]\[/)[0].gsub("[","")
-			#will need to make this multiple variables??
-				#or is this even used at all????
 			value_combinations = self.mass_product(values)
 			value_combinations.each_index do |vc_index|
 				value_combination = value_combinations[vc_index]
@@ -247,11 +274,13 @@ class OPL
 			equation.gsub("#","")
 		end
 
-		def self.sum(text, indexvalues={:indices => [], :values => []})
+		def self.sum(text, lp, indexvalues={:indices => [], :values => []})
 			#in: "i in [0,1], j in [4,-5], 3x[i][j]"
 			#out: "3x[0][4] + 3x[0][-5] + 3x[1][4] + 3x[1][-5]"
 			text = text.sub_paren_with_array
-			#text = sub_paren_with_array(text)
+			if (text.gsub(" ","")).scan(/\]\,/).size != text.scan(/in/).size
+				raise "The following sum() constraint is incorrectly formatted: #{text}. Please see the examples in test.rb for sum() constraints. I suspect you are missing a comma somewhere."
+			end
 			final_text = ""
 			element = text.split(",")[-1].gsub(" ","")
 			indices = text.scan(/[a-z] in/).map{|sc|sc[0]}
@@ -305,7 +334,7 @@ class OPL
 			final_text
 		end
 
-		def self.sub_sum(equation, indexvalues={:indices => [], :values => []})
+		def self.sub_sum(equation, lp, indexvalues={:indices => [], :values => []})
 			#in: "sum(i in (0..3), x[i]) <= 100"
 			#out: "x[0]+x[1]+x[2]+x[3] <= 100"
 			sums = (equation+"#").split("sum(").map{|ee|ee.split(")")[0..-2].join(")")}.find_all{|eee|eee!=""}.find_all{|eeee|!eeee.include?("forall")}
@@ -332,7 +361,7 @@ class OPL
 					end
 				end
 				equation = equation.gsub(text, e)
-				result = self.sum(text)
+				result = self.sum(text, lp)
 				equation = equation.gsub("sum("+text+")", result)
 			end
 			return(equation)
@@ -369,26 +398,26 @@ class OPL
 		def self.get_constants(text)
 			#in: "-8 + x + y + 3"
 			#out: "[-8, +3]"
-text = text.gsub(" ","")
-text = text+"#"
-cs = []
-potential_constants = text.scan(/[\d\.]+[^a-z^\[^\]^\d^\.^\)^\*]/)
-constants = potential_constants.find_all{|c|![*('a'..'z'),*('A'..'Z'),"["].include?(text[text.index(c)-1])}
-searchable_text = text
-constants.each_index do |i|
-constant = constants[i]
-c = constant.scan(/[\d\.]+/)[0]
-index = searchable_text.index(constant)
-if index == 0
-c = "+"+c
-else
-constant = constant.gsub('+','[+]')
-constant = constant.gsub('-','[-]')
-c = searchable_text.scan(/[\-\+]#{constant}/)[0]
-end
-cs << c.scan(/[\-\+][\d\.]+/)[0]
-searchable_text[index] = "**"
-end
+			text = text.gsub(" ","")
+			text = text+"#"
+			cs = []
+			potential_constants = text.scan(/[\d\.]+[^a-z^\[^\]^\d^\.^\)^\*]/)
+			constants = potential_constants.find_all{|c|![*('a'..'z'),*('A'..'Z'),"["].include?(text[text.index(c)-1])}
+			searchable_text = text
+			constants.each_index do |i|
+				constant = constants[i]
+				c = constant.scan(/[\d\.]+/)[0]
+				index = searchable_text.index(constant)
+				if index == 0
+					c = "+"+c
+				else
+					constant = constant.gsub('+','[+]')
+					constant = constant.gsub('-','[-]')
+					c = searchable_text.scan(/[\-\+]#{constant}/)[0]
+				end
+				cs << c.scan(/[\-\+][\d\.]+/)[0]
+				searchable_text[index] = "**"
+			end
 			return({:formatted => cs, :unformatted => constants})
 		end
 
@@ -686,6 +715,21 @@ end
 			text = text[1..-1] if text[0] == "+"
 			return(text)
 		end
+
+		def self.check_options_syntax(options)
+			return if options.empty?
+			options.each do |option|
+				if option.include?(":")
+					title = option.gsub(" ","").split(":")[0]
+					value = option.gsub(" ","").split(":")[1]
+					if !["nonnegative", "integer", "boolean", "data", "epsilon"].include?(title.downcase)
+						raise "Did not recognize the TITLE parameter '#{title}' in the options."
+					end
+				else
+					raise "Options parameter '#{option}' does not have a colon in it. The proper syntax of an option is TITLE: VALUE"
+				end
+			end
+		end
 	end
 
 	class LinearProgram
@@ -704,6 +748,9 @@ end
 		attr_accessor :variable_types
 		attr_accessor :column_bounds
 		attr_accessor :epsilon
+		attr_accessor :matrix_solution
+		attr_accessor :error_message
+		attr_accessor :stop_processing
 
 		def keys
 			[:objective, :constraints, :rows, :solution, :formatted_constraints, :rglpk_object, :solver, :matrix, :simplex_message, :mip_message, :data]
@@ -713,6 +760,38 @@ end
 			@rows = []
 			@data = []
 			@epsilon = $default_epsilon
+			@matrix_solution = {}
+			@stop_processing = false
+		end
+
+		def solution_as_matrix
+			lp = self
+			variables = lp.solution.keys.map do |key|
+				key.scan(/[a-z]/)[0] if key.include?("[")
+			end.uniq.find_all{|e|!e.nil?}
+			matrix_solution = {}
+			variables.each do |var|
+				elements = lp.solution.keys.find_all{|key|key.include?(var) && key.include?("[")}
+				num_dims = elements[0].scan(/\]\[/).size + 1
+				dim_limits = []
+				indices_value_pairs = []
+				[*(0..(num_dims-1))].each do |i|
+					dim_limit = 0
+					elements.each do |e|
+						indices = e.scan(/\[\d+\]/).map{|str|str.scan(/\d+/)[0].to_i}
+						value = lp.solution[e]
+						indices_value_pairs << [indices, value]
+						dim_limit = indices[i] if indices[i] > dim_limit
+					end
+					dim_limits << dim_limit+1
+				end
+				matrix = [].matrix(dim_limits)
+				indices_value_pairs.each do |ivp|
+					matrix.insert_at(ivp[0], ivp[1].to_f)
+				end
+				matrix_solution[var] = matrix
+			end
+			return(matrix_solution)
 		end
 	end
 
@@ -781,6 +860,7 @@ end
 end
 
 def subject_to(constraints, options=[])
+	OPL::Helper.check_options_syntax(options)
 	lp = OPL::LinearProgram.new
 	lp.original_constraints = constraints
 	variable_types = options.find_all{|option|option.downcase.include?("boolean") || option.downcase.include?("integer")} || []
@@ -798,42 +878,42 @@ def subject_to(constraints, options=[])
 	constraints = constraints.flatten
 	constraints = OPL::Helper.split_equals_a(constraints)
 	data_names = lp.data.map{|d|d.name}
-constraints = constraints.map do |constraint|
-OPL::Helper.sub_forall(constraint)
-end.flatten
-constraints = constraints.map do |constraint|
-OPL::Helper.sum_indices(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.sub_sum(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.sum_indices(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.put_constants_on_rhs(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.put_variables_on_lhs(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.sub_rhs_with_summed_constants(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.substitute_data(constraint, lp)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.put_constants_on_rhs(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.put_variables_on_lhs(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.sub_rhs_with_summed_constants(constraint)
-end
-constraints = constraints.map do |constraint|
-OPL::Helper.sum_variables(constraint, lp)
-end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sub_forall(constraint)
+	end.flatten
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sum_indices(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sub_sum(constraint, lp)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sum_indices(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.put_constants_on_rhs(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.put_variables_on_lhs(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sub_rhs_with_summed_constants(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.substitute_data(constraint, lp)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.put_constants_on_rhs(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.put_variables_on_lhs(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sub_rhs_with_summed_constants(constraint)
+	end
+	constraints = constraints.map do |constraint|
+		OPL::Helper.sum_variables(constraint, lp)
+	end
 	lp.constraints = constraints
 	all_vars = OPL::Helper.get_all_vars(constraints, lp)
 	variable_type_hash = OPL::Helper.produce_variable_type_hash(variable_types, all_vars)
@@ -904,7 +984,7 @@ end
 
 def optimize(optimization, objective, lp)
 	original_objective = objective
-	objective = OPL::Helper.sub_sum(objective)
+	objective = OPL::Helper.sub_sum(objective, lp)
 	objective = OPL::Helper.sum_indices(objective)
 	objective = OPL::Helper.substitute_data(objective, lp)
 	objective_constants = OPL::Helper.get_constants(objective)
@@ -993,5 +1073,12 @@ def optimize(optimization, objective, lp)
 	end
 	lp.solution = answer
 	lp.rglpk_object = p
+	lp.matrix_solution = lp.solution_as_matrix
+	if lp.stop_processing
+		lp.solution = lp.error_message
+		lp.matrix_solution = lp.error_message
+		lp.rglpk_object = lp.error_message
+		lp.objective = lp.error_message
+	end
 	lp
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opl
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies: []
 description: Built on top of the rglpk gem for linear programming, this gem is meant
   to give you a beautifully simple way to formulate your linear or mixed integer program.