com.gams.api.GAMSSymbolDomainViolation Class Reference

An instance of GAMSSymbolDomainViolation stores a domain violation information for a GAMSSymbol instance. More...

Public Member Functions

boolean [] getViolationArray ()
 Retrieve a violation array of boolean value with the size of the GAMSSymbol instance dimension. More...
 
GAMSSymbolRecord getRecord ()
 Retrieve a GAMSSymbolRecord instance whose domain is violated. More...
 

Detailed Description

An instance of GAMSSymbolDomainViolation stores a domain violation information for a GAMSSymbol instance.

Each GAMSSymbolDomainViolation contains two pieces of information. First, a violation array of boolean value with the size of the GAMSSymbol instance dimension. The array position contains {true} value if there is a domain violation at the relative dimension, otherwise it contains {false} value. Second, a GAMSSymbolRecord instance of the GAMSSymbol instance whose domain is violated.

See also
GAMSDatabaseDomainViolation
GAMSDatabase.checkDomains()
GAMSDatabase.getDatabaseDomainViolations(int, int)
GAMSSymbol.checkDomains()
GAMSSymbol.getSymbolDomainViolations(int)

Member Function Documentation

◆ getRecord()

GAMSSymbolRecord com.gams.api.GAMSSymbolDomainViolation.getRecord ( )

Retrieve a GAMSSymbolRecord instance whose domain is violated.

Returns
GAMSSymbolRecord instance

◆ getViolationArray()

boolean [] com.gams.api.GAMSSymbolDomainViolation.getViolationArray ( )

Retrieve a violation array of boolean value with the size of the GAMSSymbol instance dimension.

Returns
A violation array, each position contains {true} value if there is a domain violation at the relative dimension, {false} value otherwise.