IDX (IDX) API Documentation

Generated for GAMS 24.8.5

Functions, Procedures and Properties

idxGetLastError
Returns the last error number or 0 if there was no error. Calling this function will clear the last error stored.
idxErrorStr
Returns the text for a given error number. Always nonzero.
idxOpenRead
Open an existing gdx file for input. Nonzero if the file can be opened, 0 otherwise.
idxOpenWrite
Open a new gdx file for output. Nonzero if the file can be opened, 0 otherwise.
idxClose
Close a gdx file that was previously opened for reading or writing. Any pending write operations will be finished before closing
idxGetSymCount
Returns the number of indexed symbols in GDX, returns 1 on success, 0 on failure
idxGetSymbolInfo
Get information for indexed symbols in GDX, return 1 on success, 0 on failure
idxGetSymbolInfoByName
Get information for indexed symbols in GDX, return 1 on success, 0 on failure
idxGetIndexBase
Returns the index base: 0 or 1
idxSetIndexBase
Sets the index base: 0 or 1. Return 1 on success, 0 on failure
idxDataReadStart
Initialize the reading of a symbol. 0 if the operation is not possible.
idxDataRead
Read the next record. 0 if the operation is not possible.
idxDataReadDone
Finish reading of a symbol. 0 if the operation is not possible.
idxDataReadSparseColMajor
return: 1 for OK, 0 for error
idxDataReadSparseRowMajor
return: 1 for OK, 0 for error
idxDataReadDenseColMajor
return: 1 for OK, 0 for error
idxDataReadDenseRowMajor
return: 1 for OK, 0 for error
idxDataWriteStart
Start writing a new symbol. 0 if the operation is not possible.
idxDataWrite
Write a data element in raw mode. 0 if the operation is not possible.
idxDataWriteDone
idxDataWriteSparseColMajor
return: 1 if OK, 0 if error
idxDataWriteSparseRowMajor
return: 1 if OK, 0 if error
idxDataWriteDenseColMajor
return: 1 for OK, 0 for error
idxDataWriteDenseRowMajor
return: 1 for OK, 0 for error

Arguments

Calling Sequences

idxClose

  • Close a gdx file that was previously opened for reading or writing. Any pending write operations will be finished before closing
  • Function returns Integer

idxDataRead

  • Read the next record. 0 if the operation is not possible.
  • Function returns Integer
  • Arguments:
    • var keys : TgdxUELIndex
      out val : Double
      out changeIdx: Integer

idxDataReadDenseColMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • vals : PDoubleArray

idxDataReadDenseRowMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • vals : PDoubleArray

idxDataReadDone

  • Finish reading of a symbol. 0 if the operation is not possible.
  • Function returns Integer

idxDataReadSparseColMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • idxBase : Integer
      colPtr : PLongIntArray
      rowIdx : PLongIntArray
      vals : PDoubleArray

idxDataReadSparseRowMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • idxBase : Integer
      rowPtr : PLongIntArray
      colIdx : PLongIntArray
      vals : PDoubleArray

idxDataReadStart

  • Initialize the reading of a symbol. 0 if the operation is not possible.
  • Function returns Integer
  • Arguments:
    • const symName : ShortString
      out symDim : Integer
      var dims : TgdxUELIndex
      out nRecs : Integer
      out ErrMsg : ShortString

idxDataWrite

  • Write a data element in raw mode. 0 if the operation is not possible.
  • Function returns Integer
  • Arguments:
    • const keys : TgdxUELIndex
      val : Double

idxDataWriteDenseColMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • dataDim : Integer
      const vals : PDoubleArray

idxDataWriteDenseRowMajor

  • return: 1 for OK, 0 for error
  • Function returns Integer
  • Arguments:
    • dataDim : Integer
      const vals : PDoubleArray

idxDataWriteDone

  • Function returns Integer

idxDataWriteSparseColMajor

  • return: 1 if OK, 0 if error
  • Function returns Integer
  • Arguments:
    • const colPtr : PLongIntArray
      const rowIdx : PLongIntArray
      const vals : PDoubleArray

idxDataWriteSparseRowMajor

  • return: 1 if OK, 0 if error
  • Function returns Integer
  • Arguments:
    • const rowPtr : PLongIntArray
      const colIdx : PLongIntArray
      const vals : PDoubleArray

idxDataWriteStart

  • Start writing a new symbol. 0 if the operation is not possible.
  • Function returns Integer
  • Arguments:
    • const symName : ShortString
      const explTxt : ShortString
      symDim : Integer
      const dims : TgdxUELIndex
      out ErrMsg : ShortString

idxErrorStr

  • Returns the text for a given error number. Always nonzero.
  • Procedure
  • Arguments:
    • ErrNr : Integer
      out ErrMsg : ShortString

idxGetIndexBase

  • Returns the index base: 0 or 1
  • Function returns Integer

idxGetLastError

  • Returns the last error number or 0 if there was no error. Calling this function will clear the last error stored.
  • Function returns Integer

idxGetSymbolInfo

  • Get information for indexed symbols in GDX, return 1 on success, 0 on failure
  • Function returns Integer
  • Arguments:
    • iSym : Integer
      out symName : ShortString
      out symDim : Integer
      var dims : TgdxUELIndex
      out nNZ : Integer
      out explText : ShortString

idxGetSymbolInfoByName

  • Get information for indexed symbols in GDX, return 1 on success, 0 on failure
  • Function returns Integer
  • Arguments:
    • const symName : ShortString
      out iSym : Integer
      out symDim : Integer
      var dims : TgdxUELIndex
      out nNZ : Integer
      out explText : ShortString

idxGetSymCount

  • Returns the number of indexed symbols in GDX, returns 1 on success, 0 on failure
  • Function returns Integer
  • Arguments:
    • out symCount : Integer

idxOpenRead

  • Open an existing gdx file for input. Nonzero if the file can be opened, 0 otherwise.
  • Function returns Integer
  • Arguments:
    • const FileName : ShortString
      out ErrNr : Integer

idxOpenWrite

  • Open a new gdx file for output. Nonzero if the file can be opened, 0 otherwise.
  • Function returns Integer
  • Arguments:
    • const FileName : ShortString
      const Producer : ShortString
      out ErrNr : Integer

idxSetIndexBase

  • Sets the index base: 0 or 1. Return 1 on success, 0 on failure
  • Function returns Integer
  • Arguments:
    • idxBase : Integer

Undocumented Functions, Procedures and Properties

  • idxDataWriteDone

Undocumented Arguments

  • changeIdx
  • colIdx
  • colPtr
  • dataDim
  • dims
  • ErrMsg
  • ErrNr
  • explText
  • explTxt
  • FileName
  • idxBase
  • iSym
  • keys
  • nNZ
  • nRecs
  • Producer
  • result
  • rowIdx
  • rowPtr
  • symCount
  • symDim
  • symName
  • val
  • vals