MATLAB API reference

Reference documentation for the MATLAB API. MATLAB can directly consume Java classes, consult the Java documentation for more detailed information on data types and exceptions.

AMPL classes

• AMPL
  • eval
  • read
  • readData
  • solve
  • getValue
  • getData
  • setData
  • cd
  • close
  • getConstraints
  • getVariables
  • getObjectives
  • getParameters
  • getSets
  • getEntity
  • getConstraint
  • getObjective
  • getParameter
  • getSet
  • getVariable
  • isRunning
  • reset
  • display
  • show
  • expand
  • getOption
  • setOption
  • initializeEvents
  • Output
• AMPLOutput
  • msg
• Data Frame
  • Creation
  • Adding data
  • Accessing data
  • Conversion to and from MATLAB tables
  • DataFrame
  • addColumn
  • addRow
  • setColumn
  • getNumCols
  • getNumRows
  • getNumIndices
  • getRow
  • getColumn
  • setValue
  • setMatrix

Algebraic entities classes

• Constraint
  • get(key)
  • getValues
  • body()
  • dual
  • setDual(v)
  • lb
  • ub
  • drop
  • restore
• ConstraintInstance
  • body()
  • dual
  • setDual(v)
  • lb
  • ub
  • drop
  • restore
• Entity
  • get(key)
  • getValues
  • hasIndexing
  • indexarity
  • name
  • getIndices
• EntityList
• Objective
  • get(key)
  • getValues
  • value()
  • astatus
  • exitcode
  • message
  • result
• ObjectiveInstance
  • value()
  • astatus
  • exitcode
  • message
  • result
• Parameter
  • get(key)
  • getValues
  • hasDefault
  • isSymbolic
  • set(index, value)
  • setValues
• Set
  • get
  • getValues
  • asSet()
  • setValues()
  • contains()
  • size()
  • arity()
• SetInstance
  • asSet()
  • setValues()
  • contains()
  • size()
• Tuple
  • Tuple
  • elements
  • size
• Variable
  • get(key)
  • getValues
  • value()
  • setValue(v)
  • dual
  • lb
  • ub
  • getIntegrality
  • fix
  • unfix
• VariableInstance
  • value()
  • setValue(v)
  • dual
  • lb
  • ub
  • fix
  • unfix