apis/examples_python/domain__checking_8py_source.html

from gams import *

import sys


def get_data_text():

    return '''

  Sets

       i   canning plants   / seattle, san-diego /;


  Alias (i,ii);'''


if __name__ == "__main__":

    if len(sys.argv) > 1:

        ws = GamsWorkspace(system_directory = sys.argv[1])

    else:

        ws = GamsWorkspace()


    # define some data by using Python data structures

    plants   = [ "Seattle", "San-Diego" ]

    markets  = [ "New-York", "Chicago", "Topeka" ]

    capacity = { "Seattle": 350.0, "San-Diego": 600.0 }

    demand   = { "New-York": 325.0, "Chicago": 300.0, "Topeka": 275.0 }

    distance = { ("Seattle",   "New-York") : 2.5,

                 ("Seattle",   "Chicago")  : 1.7,

                 ("Seattle",   "Topeka")   : 1.8,

                 ("San-Diego", "New-York") : 2.5,

                 ("San-Diego", "Chicago")  : 1.8,

                 ("San-Diego", "Topeka")   : 1.4

               }


    # prepare a GamsDatabase with data from the Python data structures

    db = ws.add_database()


    # add two sets to the GamsDatabase

    i = db.add_set("i", 1, "canning plants")

    for p in plants:

        i.add_record(p)


    j = GamsSet(db, "j", 1, "markets")

    for m in markets:

        j.add_record(m)


    # add a parameter with domain information

    a = db.add_parameter_dc("a", [i], "capacity at plant")

    for p in plants:

        a.add_record(p).value = capacity[p]


    # if we see a domain violation something went wrong

    if not a.check_domains():

        raise Exception("*** Unexpected domain violation in a")


    # add a parameter with relaxed domain information

    b = db.add_parameter_dc("b", ["j"], "demand at market j in cases")

    for m in markets:

        b.add_record(m).value = demand[m]


    # if we see a domain violation something went wrong

    if not b.check_domains():

        raise Exception("*** Unexpected domain violation in b")


    # add a 2-dim parameter with domain information

    d = db.add_parameter_dc("d",[i,j], "distance in thousands of miles")

    for k,v in iter(distance.items()):

        d.add_record((k[0], k[1])).value = v


    # if we see a domain violation something went wrong

    if not d.check_domains():

        raise Exception("*** Unexpected domain violation in d")


    # if we see a domain violation in the database something went wrong

    if not db.check_domains():

        raise Exception("*** Unexpected domain violation in db")


    # create some "wrong" entries

    d.add_record(("Seattle", "aa")).value = 1

    d.add_record(("bb", "Seattle")).value = 1

    a.add_record("aa").value = 1

    a.add_record("bb").value = 1

    b.add_record("bb").value = 1

    b.add_record("aa").value = 1


    # now the GamsDatabase as well as the symbols a and d should have domain violations

    if db.check_domains():

        raise Exception("*** Domain violation for db not recognized")


    if a.check_domains():

        raise Exception("*** Domain violation for a not recognized")


    if d.check_domains():

        raise Exception("*** Domain violation for d not recognized")


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

    if not b.check_domains():

        raise Exception("*** Unexpected domain violation in b")


    # for a we should see 2 domain violations ("aa" and "bb")

    dv_cnt = 0

    print("Domain Violations of a:")

    for sdv in a.get_symbol_dvs():

        print(" > ", end="")

        for vi in sdv.violation_idx:

            print(vi, end=" ")

        print("<> ", end="")

        print(sdv.symbol_record.keys, end="")

        print("<<")

        dv_cnt +=1


    if dv_cnt != 2:

        raise Exception("*** Number of domain violations for a should be 2 but saw " + str(dvCnt))


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

    dv_cnt = 0

    print("Domain Violations of d:")

    for sdv in d.get_symbol_dvs():

        print(" > ", end="")

        for vi in sdv.violation_idx:

            print(vi, end=" ")

            if vi:

                dv_cnt +=1


        print("<> ", end="")

        print(sdv.symbol_record.keys, end="")

        print("<<")


    if dv_cnt != 3:

        raise Exception("*** Number of domain violations for a should be 3 but saw ",  str(dv_cnt))


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

    dv_cnt = 0

    print("Domain Violations of db:")

    for ddv in db.get_database_dvs():

        print(" > " + ddv.symbol.name + ": ")

        for sdv in ddv.symbol_dvs:

            print("   ", end="")

            for vi in sdv.violation_idx:

                print(vi, end=" ")

                if vi:

                    dv_cnt += 1

            print("<> ", end="")

            print(sdv.symbol_record.keys, end="")

            print ("<<")


    if dv_cnt != 5:

        raise Exception("*** Number of domain violations for db should be 5 but saw " + str(dv_cnt))


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

    dv_cnt = 0

    print("Domain Violations of db:")

    for ddv in db.get_database_dvs(3):

        print(" > " + ddv.symbol.name + ": ")

        for sdv in ddv.symbol_dvs:

            print ("   ", end="")

            for vi in sdv.violation_idx:

                print(vi, end=" ")

            print("<> ", end="")

            print(sdv.symbol_record.keys, end="")

            print("<<")

            dv_cnt += 1

    if dv_cnt != 3:

        raise Exception("*** Number of domain violations for db should be 3 but saw " + str(dv_cnt))


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

    dv_cnt = 0

    print("Domain Violations of db:")

    for ddv in db.get_database_dvs(0, 1):

        print(" > " + ddv.symbol.name + ": ")

        for sdv in ddv.symbol_dvs:

            print("   ", end="")

            for vi in sdv.violation_idx:

                print(vi, end=" ")

            print("<> ", end="")

            print(sdv.symbol_record.keys, end="")

            print("<<")

            dv_cnt += 1


    if dv_cnt != 2:

        raise Exception("*** Number of domain violations for db should be 2 but saw " + str(dv_cnt))


    # by default we should get an exception when exporting a GamsDatabase with domain violations

    saw_exception = False

    try:

        db.export("test.gdx")

    except:

        saw_exception = True

        db.suppress_auto_domain_checking = True

        db.export("test.gdx")

    if not saw_exception:

        raise Exception("*** It should not be possible to export a GamsDatabase containing domain violations by default")


    # read a parameter with domain info from gdx

    db2 = ws.add_database_from_gdx("test.gdx")

    d2 = db2.get_parameter("d")


    # the domain of the parameter should be GamsSet i and GamsSet j

    for item in d2.domains:

        if isinstance(item, GamsSet):

            if item.name == "i":

                for uel in item:

                    if not uel.key(0) in plants:

                        raise Exception("*** Unexpected uel " + str(uel.key(0)) + " found in domain i")


            elif item.name == "j":

                for uel in item:

                    if not uel.key(0) in markets:

                        raise Exception("*** Unexpected uel " + str(uel.key(0)) + " found in domain j")


            else:

                raise Exception("*** Expected GamsSet i and j but found " + item.name)

        else:

            raise Exception("*** Expected GamsSet as domain but found relaxed domain " + item)


    '''

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

    make sure that certain things are working as expected.

    '''


    # try reading an alias as set

    j_alias = ws.add_job_from_string(get_data_text())

    j_alias.run()

    ii = j_alias.out_db.get_set("ii")

    print("Elements of aliased Set:")

    for item in ii:

        print(" > " + item.key(0))


    test_db = ws.add_database()

    test_set = test_db.add_set("test", 1)


    # Try adding empty UEL

    test_set.add_record((""))

    print("Elements of test Set after adding empty UEL:")

    print(" > " + str(test_set.number_records))


    # GAMS strips pending blanks while leading blanks are relevant

    test_set.add_record(" a ").text = "a"

    print("Record 'a' should be the same as 'a':")

    print(" > " + test_set.find_record(" a").text)


    # GAMS cannot handle UELs with more than 63 characters

    # This should be OK ...

    test_set.add_record("123456789012345678901234567890123456789012345678901234567890123 ").text = "OK"


    # ... but not this

    saw_exception = False

    try:

        test_set.add_record("1234567890123456789012345678901234567890123456789012345678901234").text = "not OK"

    except:

        saw_exception = True

    if not saw_exception:

        raise Exception("*** It should not be possible to add a record with more than 63 characters")


    # GAMS cannot handle explanatory texts with more than 255 characters

    test_db.add_set("textOK", 1, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345")

    saw_exception = False

    try:

        test_db.add_set("textNotOK", 1, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456")

    except:

        saw_exception = True

    if not saw_exception:

        raise Exception("*** It should not be possible to add an explanatory text with more than 255 characters")


    test_set.add_record("OK").text = "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345"

    saw_exception = False

    try:

        testSet.AddRecord("notOK").Text = "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

    except:

        saw_exception = True

    if not saw_exception:

        raise Exception("*** It should not be possible to add an explanatory text with more than 255 characters")


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

    test_set.add_record("quote'")

    test_set.add_record("quote\"")

    saw_exception = False

    try:

        test_set.add_record("quote'\"")

    except:

        saw_exception = True

    if not saw_exception:

        raise Exception("*** It should not be possible to add a record single AND double quote")

    test_db.export("test.gdx")