apis/examples_matlab_control/TransportModel_8m_source.html

classdef TransportModel < handle


    properties (SetAccess = private)

        i

        j

        a

        b

        c

        d

        f

        x

        z

        opt

        ws

        dbin1

        dbin2

        dbout1

        job

    end


    methods


        function obj = TransportModel(ws)


            obj.ws = ws;

            obj.opt = obj.ws.addOptions();


            obj.dbin1 = obj.ws.addDatabase('dbIn1');

            obj.dbin2 = obj.ws.addDatabase('dbIn2');


            obj.opt.defines('dbIn1', 'dbIn1');

            obj.opt.defines('dbIn2', 'dbIn2');

            obj.opt.setAllModelTypes('cplex');

            obj.opt.defines('dbOut1', 'dbOut1');

            obj.opt.solveLink = gams.control.options.SolveLink.LoadLibrary;


            obj.i = obj.dbin1.addSet('i', 'canning plants');

            obj.j = obj.dbin1.addSet('j', 'markets');

            obj.a = obj.dbin1.addParameter('a', 'capacity of plant i in cases', obj.i);

            obj.b = obj.dbin1.addParameter('b', 'demand at market j in cases', obj.j);

            obj.d = obj.dbin1.addParameter('d', 'distance in thousands of miles', obj.i, obj.j);

            obj.f = obj.dbin2.addParameter('f', 'freight in dollars per case per thousand miles');


            obj.job = obj.ws.addJobFromString(obj.modelSource());

        end


        function run(obj, cp, output)

            if ~obj.dbin1.checkDomains()

                error('Domain Errors in Database 1');

            end

            if ~obj.dbin2.checkDomains()

                error('Domain Errors in Database 2');

            end


            if isempty(cp) && isempty(output)

                obj.job.run(obj.opt, false, obj.dbin1, obj.dbin2);

            elseif isempty(cp)

                obj.job.run(obj.opt, output, false, obj.dbin1, obj.dbin2);

            elseif isempty(output)

                obj.job.run(obj.opt, checkpoint, false, obj.dbin1, obj.dbin2);

            else

                obj.job.run(obj.opt, checkpoint, output, false, obj.dbin1, obj.dbin2);

            end


            obj.dbout1 = obj.ws.addDatabaseFromGDX(sprintf('%s.gdx', obj.opt.getDefinitionOf('dbOut1')));

            obj.x = obj.dbout1.getVariable('x');

            obj.z = obj.dbout1.getVariable('z');

        end


        function model = modelSource(obj)

            model = {

                'Sets                                                                       '

                '      i   canning plants                                                   '

                '      j   markets                                                          '

                '                                                                           '

                ' Parameters                                                                '

                '      a(i)   capacity of plant i in cases                                  '

                '      b(j)   demand at market j in cases                                   '

                '      d(i,j) distance in thousands of miles                                '

                ' Scalar f  freight in dollars per case per thousand miles;                 '

                '                                                                           '

                '$if not set dbIn1 $abort ''no file name for in-database 1 file provided''    '

                '$gdxin %dbIn1%                                                             '

                '$load i j a b d                                                            '

                '$gdxin                                                                     '

                '                                                                           '

                '$if not set dbIn2 $abort ''no file name for in-database 2 file provided''    '

                '$gdxin %dbIn2%                                                             '

                '$load f                                                                    '

                '$gdxin                                                                     '

                '                                                                           '

                ' Parameter c(i,j)  transport cost in thousands of dollars per case ;       '

                '                                                                           '

                '            c(i,j) = f * d(i,j) / 1000 ;                                   '

                '                                                                           '

                ' Variables                                                                 '

                '       x(i,j)  shipment quantities in cases                                '

                '       z       total transportation costs in thousands of dollars ;        '

                '                                                                           '

                ' Positive Variable x ;                                                     '

                '                                                                           '

                ' Equations                                                                 '

                '                                                                           '

                '      cost        define objective function                                '

                '      supply(i)   observe supply limit at plant i                          '

                '      demand(j)   satisfy demand at market j ;                             '

                '                                                                           '

                '  cost ..        z  =e=  sum((i,j), c(i,j)*x(i,j)) ;                       '

                '                                                                           '

                '  supply(i) ..   sum(j, x(i,j))  =l=  a(i) ;                               '

                '                                                                           '

                '  demand(j) ..   sum(i, x(i,j))  =g=  b(j) ;                               '

                '                                                                           '

                ' Model transport /all/ ;                                                   '

                '                                                                           '

                ' Solve transport using lp minimizing z ;                                   '

                '                                                                           '

                ' Display x.l, x.m ;                                                        '

                '$if not set dbOut1 $abort ''no file name for out-database 1 file provided''  '

                'execute_unload ''%dbOut1%'', x, z;                                           '

                '                                                                           '};

            model = sprintf('%s\n', model{:});

        end


    end


end