Constraint Satisfaction Programming With Microsoft Solver Foundation

standardized test“Greg, Marcia, Peter, Jan, Bobby and Cindy go to a movie and sit next to each other in six adjacent seats. If Marcia and Jan will not sit next to each other, in how many different arrangements can the six people sit?”  GMAT Sample Question

Thankfully my standardized test-taking days are far behind me, but this kind of problem is typical of what one might find on an advanced level standardized test math section. It also so happens to be representative of what mathematicians refer to as a constraint problem.

Constraint problems (also commonly known as constraint satisfaction problems or CSPs) refer to a family of mathematical optimization problems. Wikipedia defines constraint satisfaction as follows: “…the process of finding a solution to a set of constraints that impose conditions that the variables must satisfy. A solution is therefore a set of values for the variables that satisfies all constraints.

chocolate-factory-pictureWith that aside, I’d like to continue with a simple illustration that might help put some understanding behind these abstract definitions. For a moment, just imagine that you are the owner of a chocolate factory…

As a chocolate factory, your company is the sole supplier of three types of chocolate to a retailer whom we shall call “Bradburys.”  The three types of candy are Darkness, Heaven, and Therapy (these don’t actually exist as far as I know but can help with your imagination, YMMV). Now as CEO of your chocolate factory, your task is to maximize profit by keeping production costs low and output high. Seems straightforward, right? However with chocolate production, as in life, things are a little bit more complex.

Your factory has three machines – each producing only one type of candy. This limits the overall production for each type of candy to the capacity of the machine that can produce it. You also have a limited budget, and since chocolate doesn’t grow on trees (OK, technically cocoa does, but you know what I mean), you have to make financial decisions about what quantity of the different chocolates you are willing to produce. And just to make it even more complicated, some chocolate candies can be sold more profitably to Bradbury’s than others. Hmm, some tough decisions to make…

Turns out, not coincidentally, that this example qualifies as a perfect candidate for a constraint satisfaction problem. The problem is how much of the different quantities of chocolate to produce to maximize profit. The constraints are (1) having only three machines, (2) the budget, and (3) the profitability functions for each of the chocolates. Don’t worry, my hungry audience, we’ll come back to this example later, but for now we need to talk a little bit about programming…

The Microsoft Solver Foundation (MSF)

To help solve CSPs and other mathematical problems, Microsoft had kindly developed something called the Microsoft Solver Foundation[1] (MSF). From their website, MSF “…is a set of development tools for mathematical simulation, optimization, and modeling that relies on a managed execution environment and the common language runtime (CLR).

Seems like a great fit for helping us with our problem! So from here on out we are going to look at using MSF and later see how we can programatically apply it to the chocolate factory problem.

Getting Started With Microsoft Solver Foundation

For our intent and purposes, the Solver Foundation is really a single class library called Microsoft.Solver.Foundation.dll. To access the functionality of MSF, we simply need to include a reference to this file. However, there is no NuGet package for this library, it has to be downloaded from here and installed:

Download Screen

The latest MSF requires a minimum of .NET 4.0 and VS 2010. Unfortunately there is no vsix template or any other indication in Visual Studio that lets you know that MSF is installed. Instead you will need to know the location of the .DLL installed which for me was found at this rather non-intuitive path:

C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\Microsoft.Solver.Foundation.dll

While you’re trying to locate the MSF .DLL library you may also notice there is a “Samples” folder: (%USERPROFILE%\Documents\Microsoft Solver Foundation\Samples). This folder contains numerous code examples that use MSF to solve many different types of problems. If you find this topic interesting, I highly recommend spending some time playing around with the examples. Personally I’ve found them to be the best way to learn MSF.

Back to Our Chocolate Factory Example

New CSP SolutionNow, the next step is to set up our solution, so we create a blank solution and create a new C# Console project. (It doesn’t strictly have to be a Console project, but for ease of demonstration we’ll use one). Once we’ve created the project we add a reference to Microsoft.Solver.Foundation via the “Add Reference” context dialog:

Now this is where things get interesting. We will work in the Program.cs file and the first thing we need to do is initialize our Solver library and define our model and outputs. The way we do that in code is this:

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.Threading.Tasks;
  6. using Microsoft.SolverFoundation.Services;
  7. namespace ChocolateFactory
  8. {
  9.     class Program
  10.     {
  11.         static void Main(string[] args)
  12.         {
  13.             // Initializing the solver.
  14.             var solver = SolverContext.GetContext();
  15.             var model = solver.CreateModel();
  16.             // Defining our final outputs. These are referred to as our “decisions”.
  17.             var numDarkness = newDecision(Domain.IntegerNonnegative, “Darkness”);
  18.             var numHeaven = newDecision(Domain.IntegerNonnegative, “Heaven”);
  19.             var numTherapy = newDecision(Domain.IntegerNonnegative, “Therapy”);
  20.             // Adding these outputs to the model the solver will use.
  21.             model.AddDecision(numDarkness);
  22.             model.AddDecision(numHeaven);
  23.             model.AddDecision(numTherapy);
  24.         }
  25.     }
  26. }

So, two things to quickly note. The first is that we are defining a “solver.” MSF uses many different types of solvers for solving different types of problems. Once you have set up your problem, MSF by default will pick a solver for the type of problem it thinks you are trying to solve (in our case it would be the “Simplex” algorithm). You can think of a solver as the mechanism that actually abstracts the difficult math that goes on behind the scenes. From the perspective of design patterns, you can think of MSF as applying the “Strategy” pattern by delegating an algorithm at run-time to solve our particular problem. The second thing to understand is that we are defining our “outputs” or the format of what our answers should look like. To help the solver, we must define the type of output we are looking for. In this case it is a non-negative integer that will represent the quantity to produce of a given type of chocolate.

The second stage is where we can define all our constraints and our goal:

  1. var maxBudget = 500;
  2. // Our costs
  3. var darknessCost = 2;
  4. var heavenCost = 3;
  5. var therapyCost = 5;
  6. // Our sell prices
  7. var darknesSellprice = 5;
  8. var heavenSellprice = 8;
  9. var therapySellprice = 15;
  10. //our machine capacity
  11. var darknessCapacity = 65;
  12. var heavenCapacity = 55;
  13. var therapyCapacity = 45;
  14. // We define the expression of our cost < maxBudget
  15. model.AddConstraint(
  16.     “Budget”,
  17.     darknessCost * numDarkness +
  18.     heavenCost * numHeaven +
  19.     therapyCost * numTherapy
  20.     <= maxBudget);
  21. model.AddConstraint(“Capacity1”, numDarkness < darknessCapacity);
  22. model.AddConstraint(“Capacity2”, numHeaven < heavenCapacity);
  23. model.AddConstraint(“Capacity3”, numTherapy < therapyCapacity);
  24. // Define goal to maximize profit
  25. model.AddGoal(“BestProfit”, GoalKind.Maximize,
  26. (darknesSellprice – darknessCost) * numDarkness +
  27. (heavenSellprice – heavenCost) * numHeaven +
  28. (therapySellprice – therapyCost) * numTherapy);

The tricky thing here is getting used to the way constraints are defined as algebraic statements of equalities/inequalities. But beyond that, the code is fairly self-explanatory.

Finally we tell the solver to “solve” our constraint problem:

  1. // Solve our problem
  2. var solution = solver.Solve();
  3. // Get our decisions
  4. Console.WriteLine(“Solution found with a quality considered : “ + solution.Quality.ToString());
  5. Console.WriteLine(“You should produce {0} of ‘Darkness'”, numDarkness);
  6. Console.WriteLine(“You should produce {0} ‘Heaven'”, numHeaven);
  7. Console.WriteLine(“You should produce {0} ‘Therapy'”, numTherapy);
  8. double totalCost = numDarkness.ToDouble() * darknessCost + numHeaven.ToDouble() * heavenCost + numTherapy.ToDouble() * therapyCost;
  9. double totalRevenue = numDarkness.ToDouble() * darknesSellprice + numHeaven.ToDouble() * heavenSellprice + numTherapy.ToDouble() * therapySellprice;
  10. double totalProfit = totalRevenue – totalCost;
  11. Console.WriteLine(“Budget used : ${0} out of ${1}”, totalCost, maxBudget);
  12. Console.WriteLine(“Total Revenue : ${0}”, totalRevenue);
  13. Console.WriteLine(“Profit : ${0}”, totalProfit);
  14. Console.ReadLine();

And we run our program display some output:

Final Results

So from here we can see the respective quantities of what our little chocolate factory should produce. By tweaking the selling prices, machine output capacities, etc. you can get different “optimal” results. Fun stuff!

Map ProblemHope you enjoyed this introduction to constraint satisfaction problems. My next blog post will be a continuation in this series where we look at solving the famous “map coloring” problem using constraint satisfaction techniques and MSF.


[1] As of May 2012, sadly MSF is no longer being actively developed by Microsoft as they are pivoting to integrate MSF into another kind of analytics framework. The principles of constraint satisfaction problem solving are still relevent in general and will likely carry over to the new product.

About David Green

David Green joined AIS-Raleigh in September of 2011 as a Senior Software Engineer. During his university years he set his mind on becoming a clinical psychologist, but after graduating realized he really loved programming more and redirected his attention to software development for the web. He appreciates programs that are cleanly and well architected with a preference for minimalism when it comes to front-end UI design and database architecture. His primary areas of interest are C#/MVC4 framework, iOS programming and NoSQL systems. Currently he is aspiring to be a Pluralsight author for NoSQL topics.

David holds a Bachelor’s degree in psychology and economics from Northwestern University and a Masters in computer science from DePaul University with a concentration in artificial intelligence. He lives in Durham, North Carolina with his wife and two kids. In his spare time he loves to read on his Kindle, watch college football and work on improving his bench press.

  • Jamie Dixon

    Awesome job.

    The tricky thing here is getting used to the way constraints are defined as algebraic statements of equalities/inequalities

    I bet your problems with the syntax can be mitigated using F#