apis/examples_matlab_control/domain__check_8m_source.html

function domain_check(varargin)


    % check workspace info from arguments

    if nargin > 0

        wsInfo = gams.control.WorkspaceInfo();

        wsInfo.systemDirectory = varargin{1};

        ws = gams.control.Workspace(wsInfo);

    else

        ws = gams.control.Workspace();

    end


    % prepare input data

    plants = {'Seattle', 'San-Diego'};

    markets = {'New-York', 'Chicago', 'Topeka'};

    capacity = [350, 600];

    demand = [325, 300, 275];

    distance = [2.5, 1.7, 1.8; 2.5, 1.8, 1.4];


    % prepare a Database with the data above

    db = ws.addDatabase();


    % add two sets to the Database

    i = db.addSet('i', 1, 'canning plants');

    for k = 1:numel(plants)

        i.addRecord(plants{k});

    end

    j = db.addSet('j', 1, 'markets');

    for k = 1:numel(markets)

        j.addRecord(markets{k});

    end


    % add a parameter with domain information

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

    for k = 1:numel(plants)

        rec = a.addRecord(plants{k});

        rec.value = capacity(k);

    end

    % if we see a domain violation something went wrong

    if ~a.checkDomains()

        error('Unexpected domain violation in a');

    end


    % add a parameter with relaxed domain information

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

    for k = 1:numel(markets)

        rec = b.addRecord(markets{k});

        rec.value = demand(k);

    end

    if ~b.checkDomains()

        error('Unexpected domain violation in b');

    end


    % add a 2-dim parameter with domain information

    domains = {i, j};

    d = db.addParameter('d', 'distance in thousands of miles', domains);

    for k1 = 1:numel(plants)

        for k2 = 1:numel(markets)

            keys = {plants{k1}, markets{k2}};

            rec = d.addRecord(keys);

            rec.value = distance(k1,k2);

        end

    end

    if ~d.checkDomains()

        error('Unexpected domain violation in d');

    end


    if ~db.checkDomains()

        error('Unexpected domain violation in db');

    end


    % create some 'wrong' entries

    rec = d.addRecord({'Seattle', 'aa'});

    rec.value = 1;

    rec = d.addRecord({'bb', 'Seattle'});

    rec.value = 1;


    rec = a.addRecord('aa');

    rec.value = 1;

    rec = a.addRecord('bb');

    rec.value = 1;

    rec = b.addRecord('aa');

    rec.value = 1;

    rec = b.addRecord('bb');

    rec.value = 1;


    % now the database as well as the symbols a and d should have domain violations

    if db.checkDomains()

        error('Domain violation for db not recognized');

    end

    if a.checkDomains()

        error('Domain violation for a not recognized');

    end

    if d.checkDomains()

        error('Domain violation for d not recognized');

    end


    % b in contrast was defined with relaxed domain info only, therefore we should never see a domain violation

    if ~b.checkDomains()

        error('Unexpected domain violation in b');

    end


    % for a, we should see 2 domain violations ('aa' and 'bb')

    fprintf('Symbol Domain Violations of a:\n');

    dvCnt = list_domain_violations('', a.getSymbolDomainViolations(0), 0);

    if dvCnt ~= 2

        error('Expected 2 domain violation records of a, but found [%d]', dvCnt);

    end


    % for d, we should see 3 domain violations ('Seattle', *'aa'*; *'bb'*, *'Seattle'*)

    fprintf('Symbol Domain Violations of d:\n');

    dvCnt = list_domain_violations('', d.getSymbolDomainViolations(0), 0);

    if dvCnt ~= 3

        error('Expected 3 domain violation records of d, but found [%d]', dvCnt);

    end


    % for db, we should see 5 domain violations (all the ones from a and d)

    dvCnt = 0;

    fprintf('Database Domain Violations of db without maximum limit of record numbers:\n');

    dbDomViolations = db.getDatabaseDomainViolations(0,0);

    for i = 1:numel(dbDomViolations)

        name = dbDomViolations{i}.symbol.name;

        dvCnt = list_domain_violations(name, dbDomViolations{i}.symbolDomainViolations, dvCnt);

    end

    if dvCnt ~= 5

        error('Expected 5 domain violation records of db, but found [%d]', dvCnt);

    end


    % now we limit the amount of violated records reported to a total of 3

    dvCnt = 0;

    fprintf('Database Domain Violations of db with no more than 3 violation records:\n');

    dbDomViolations = db.getDatabaseDomainViolations(3,0);

    for i = 1:numel(dbDomViolations)

        name = dbDomViolations{i}.symbol.name;

        dvCnt = list_domain_violations(name, dbDomViolations{i}.symbolDomainViolations, dvCnt);

    end

    if dvCnt ~= 3

        error('Expected 3 domain violation records of db, but found [%d]', dvCnt);

    end


    % now we limit the amount of violated records reported to 1 per symbol

    dvCnt = 0;

    fprintf('Database Domain Violations of db with no more than 1 violation record per 1 symbol:\n');

    dbDomViolations = db.getDatabaseDomainViolations(0,1);

    for i = 1:numel(dbDomViolations)

        name = dbDomViolations{i}.symbol.name;

        dvCnt = list_domain_violations(name, dbDomViolations{i}.symbolDomainViolations, dvCnt);

    end

    if dvCnt ~= 2

        error('Expected 2 domain violation records of db, but found [%d]', dvCnt);

    end


    % by default we should get an exception when exporting a Database with domain violations

    sawException = false;

    try

        db.export('test.gdx');

    catch

        sawException = true;

        db.suppressAutoDomainChecking = true;

        db.export('test.gdx');

    end

    if ~sawException

        error('It should not be possible to export a Database containing domain violations by default');

    end


    % read a parameter with domain info from gdx

    db2 = ws.addDatabaseFromGDX('test.gdx');

    d2 = db2.getParameter('d');


    % the domain of the parameter should be Set i and Set j

    domains = d2.domains;

    for i = 1:numel(domains)

        if ~isa(domains{i}, 'gams.control.Set')

            error('Expected Set as domain but found relaxed domain %s', item);

        end

        if strcmp(domains{i}.name, 'i')

            if ~check_uel(domains{i}, plants)

                error('Unexpected uel found in domain i');

            end

        elseif strcmp(domains{i}.name, 'j')

            if ~check_uel(domains{i}, markets)

                error('Unexpected uel found in domain j');

            end

        else

            error('Expected Set i and j but found %s', domains{i}.name);

        end

    end


    % *************************************************************** %

    % This next section is acutally not about domain checking, but we %

    % make sure that certain things are working as expected.          %

    % *************************************************************** %


    aliasData = {

    'Sets                                             '

    '    i   canning plants   / seattle, san-diego /; '

    '                                                 '

    'Alias (i,ii);                                    '};

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


    % Try reading an Alias as Set

    aliasJob = ws.addJobFromString(aliasData);

    aliasJob.run();

    ii = aliasJob.outDB.getSet('ii');

    fprintf('Elements of aliased Set:');

    for rec = ii.records

        fprintf(' > %s\n', rec{1}.key(1));

    end


    testDB = ws.addDatabase();

    testSet = testDB.addSet('test', 1);


    % Try adding empty UEL

    testSet.addRecord('');

    fprintf('Elements of test Set after adding empty UEL:\n');

    fprintf(' > %d\n', testSet.numberOfRecords);


    % GAMS strips pending blanks while leading blanks are relevant

    rec = testSet.addRecord(' a ');

    rec.text = 'a';

    fprintf('Record '' a '' should be the same as '' a'':\n');

    fprintf(' > %s\n', testSet.findRecord(' a').text);


    % GAMS cannot handle UELs with more than 63 characters

    % This should be OK ...

    rec = testSet.addRecord('123456789012345678901234567890123456789012345678901234567890123 ');

    rec.text = 'OK';

    % ... but not this

    try

        error_thrown = true;

        rec = testSet.addRecord('1234567890123456789012345678901234567890123456789012345678901234');

        rec.text = 'not OK';

        error_thrown = false;

    catch

    end

    if ~error_thrown

        error('It should not be possible to add a record with more than 63 characters');

    end


    % GAMS cannot handle explanatory texts with more than 255 characters

    testDB.addSet('textOK', '123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345');

    try

        error_thrown = true;

        testDB.addSet('textNotOK', '1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456');

        error_thrown = false;

    catch

    end

    if ~error_thrown

        error('It should not be possible to add an explanatory text with more than 255 characters');

    end


    rec = testSet.addRecord('OK');

    rec.text = '123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345';

    try

        error_thrown = true;

        rec = testSet.addRecord('notOK');

        rec.text = '1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456';

        error_thrown = false;

    catch

    end

    if ~error_thrown

        error('It should not be possible to add an explanatory text with more than 255 characters');

    end


    % GAMS can handle UELs containing single and double quotes but not at the same time

    testSet.addRecord('quote''');

    testSet.addRecord('quote"');

    try

        error_thrown = true;

        testSet.addRecord('quote''"');

        error_thrown = false;

    catch

    end

    if ~error_thrown

        error('It should not be possible to add a record single AND double quote');

    end


    testDB.export('test.gdx');


    fprintf('successfully terminated!\n');


end


function dvCnt = list_domain_violations(symbolName, domViolations, dvCnt)

    for j = 1:numel(domViolations)

        fprintf(' > %s [', symbolName);

        item1 = domViolations{j}.violationArray;

        for k = 1:numel(item1)

            if item1(k)

                fprintf('true ');

                dvCnt = dvCnt + 1;

            else

                fprintf('false ');

            end

        end

        fprintf('] <> ');

        item2 = domViolations{j}.record.keys;

        for k = 1:numel(item2)

            fprintf('%s ', item2{k});

        end

        fprintf('<<\n');

    end

end


function ret = check_uel(symbol, uels)

    ret = true;

    for rec = symbol.records

        key = rec{1}.key(1);

        is_contained = false;

        for i = 1:numel(uels)

            if strcmp(key, uels{i})

                is_contained = true;

                break;

            end

        end

        if ~is_contained

            ret = false;

            return

        end

    end

    return

end