8. API Reference

This topic describes the definitions and call specifications of Mindo APIs.

• 8.1. C API
  • 8.1.1. Environment management
  • 8.1.2. Model management
  • 8.1.3. IO management
  • 8.1.4. Attribute management
  • 8.1.5. Parameter management
  • 8.1.6. Solution management
• 8.2. C++ API
  • 8.2.1. MdoCol
  • 8.2.2. MdoCons
  • 8.2.3. MdoEnv
  • 8.2.4. MdoException
  • 8.2.5. MdoExpr
  • 8.2.6. MdoExprLinear
  • 8.2.7. MdoModel
  • 8.2.8. MdoVar
• 8.3. Python API
  • 8.3.1. MdoCol
    • mindoptpy.MdoCol
      • mindoptpy.MdoCol.add_term()
      • mindoptpy.MdoCol.add_terms()
      • mindoptpy.MdoCol.clear()
      • mindoptpy.MdoCol.get_coeff()
      • mindoptpy.MdoCol.get_cons()
      • mindoptpy.MdoCol.get_size()
      • mindoptpy.MdoCol.get_terms()
      • mindoptpy.MdoCol.remove_cons()
      • mindoptpy.MdoCol.remove_term()
  • 8.3.2. MdoCons
    • mindoptpy.MdoCons
      • mindoptpy.MdoCons.get_index()
      • mindoptpy.MdoCons.get_int_attr()
      • mindoptpy.MdoCons.get_real_attr()
      • mindoptpy.MdoCons.get_str_attr()
      • mindoptpy.MdoCons.same_as()
      • mindoptpy.MdoCons.set_int_attr()
      • mindoptpy.MdoCons.set_real_attr()
      • mindoptpy.MdoCons.set_str_attr()
  • 8.3.3. MdoEnv
    • mindoptpy.MdoEnv
      • mindoptpy.MdoEnv.get_env()
  • 8.3.4. MdoException
    • mindoptpy.MdoError
      • mindoptpy.MdoError.args
      • mindoptpy.MdoError.with_traceback()
  • 8.3.5. MdoExpr
    • mindoptpy.MdoExpr
  • 8.3.6. MdoExprLinear
    • mindoptpy.MdoExprLinear
      • mindoptpy.MdoExprLinear.add_constant()
      • mindoptpy.MdoExprLinear.add_term()
      • mindoptpy.MdoExprLinear.add_terms()
      • mindoptpy.MdoExprLinear.clear()
      • mindoptpy.MdoExprLinear.get_coeff()
      • mindoptpy.MdoExprLinear.get_constant()
      • mindoptpy.MdoExprLinear.get_terms()
      • mindoptpy.MdoExprLinear.get_var()
      • mindoptpy.MdoExprLinear.remove_term()
      • mindoptpy.MdoExprLinear.remove_var()
      • mindoptpy.MdoExprLinear.set_constant()
      • mindoptpy.MdoExprLinear.get_dual_value()
  • 8.3.7. MdoModel
    • mindoptpy.MdoModel
      • mindoptpy.MdoModel.conss_
      • mindoptpy.MdoModel.vars_
      • mindoptpy.MdoModel.add_cons()
      • mindoptpy.MdoModel.add_cons2()
      • mindoptpy.MdoModel.add_conss()
      • mindoptpy.MdoModel.add_var()
      • mindoptpy.MdoModel.add_vars()
      • mindoptpy.MdoModel.create_mdl()
      • mindoptpy.MdoModel.delete_conss()
      • mindoptpy.MdoModel.delete_elements()
      • mindoptpy.MdoModel.delete_all_elements()
      • mindoptpy.MdoModel.delete_all_quadratic_elements()
      • mindoptpy.MdoModel.delete_vars()
      • mindoptpy.MdoModel.display_results()
      • mindoptpy.MdoModel.explain_result()
      • mindoptpy.MdoModel.explain_status()
      • mindoptpy.MdoModel.compute_iis()
      • mindoptpy.MdoModel.free_mdl()
      • mindoptpy.MdoModel.get_col()
      • mindoptpy.MdoModel.get_cons()
      • mindoptpy.MdoModel.get_conss()
      • mindoptpy.MdoModel.get_elements()
      • mindoptpy.MdoModel.get_expr_linear()
      • mindoptpy.MdoModel.get_int_attr()
      • mindoptpy.MdoModel.get_int_attr_array()
      • mindoptpy.MdoModel.get_int_attr_conss()
      • mindoptpy.MdoModel.get_int_attr_index()
      • mindoptpy.MdoModel.get_int_attr_vars()
      • mindoptpy.MdoModel.get_int_param()
      • mindoptpy.MdoModel.get_obj_offset()
      • mindoptpy.MdoModel.get_objs()
      • mindoptpy.MdoModel.get_real_attr()
      • mindoptpy.MdoModel.get_real_attr_array()
      • mindoptpy.MdoModel.get_real_attr_conss()
      • mindoptpy.MdoModel.get_real_attr_index()
      • mindoptpy.MdoModel.get_real_attr_vars()
      • mindoptpy.MdoModel.get_real_param()
      • mindoptpy.MdoModel.get_result()
      • mindoptpy.MdoModel.get_status()
      • mindoptpy.MdoModel.get_str_attr_index()
      • mindoptpy.MdoModel.get_str_param()
      • mindoptpy.MdoModel.get_var()
      • mindoptpy.MdoModel.get_vars()
      • mindoptpy.MdoModel.add_sym_mat()
      • mindoptpy.MdoModel.add_sym_mats()
      • mindoptpy.MdoModel.replace_sym_mat_objs()
      • mindoptpy.MdoModel.replace_sym_mat_elements()
      • mindoptpy.MdoModel.get_real_attr_sym_mat()
      • mindoptpy.MdoModel.is_max_obj_sense()
      • mindoptpy.MdoModel.is_min_obj_sense()
      • mindoptpy.MdoModel.load_model()
      • mindoptpy.MdoModel.read_prob()
      • mindoptpy.MdoModel.read_task()
      • mindoptpy.MdoModel.retrieve_task()
      • mindoptpy.MdoModel.set_elements()
      • mindoptpy.MdoModel.set_quadratic_elements()
      • mindoptpy.MdoModel.set_int_attr()
      • mindoptpy.MdoModel.set_int_attr_array()
      • mindoptpy.MdoModel.set_int_attr_conss()
      • mindoptpy.MdoModel.set_int_attr_index()
      • mindoptpy.MdoModel.set_int_attr_vars()
      • mindoptpy.MdoModel.set_int_param()
      • mindoptpy.MdoModel.set_max_obj_sense()
      • mindoptpy.MdoModel.set_min_obj_sense()
      • mindoptpy.MdoModel.set_obj_offset()
      • mindoptpy.MdoModel.set_objs()
      • mindoptpy.MdoModel.set_real_attr()
      • mindoptpy.MdoModel.set_real_attr_array()
      • mindoptpy.MdoModel.set_real_attr_conss()
      • mindoptpy.MdoModel.set_real_attr_index()
      • mindoptpy.MdoModel.set_real_attr_vars()
      • mindoptpy.MdoModel.set_real_param()
      • mindoptpy.MdoModel.set_str_attr_index()
      • mindoptpy.MdoModel.set_str_param()
      • mindoptpy.MdoModel.solve_prob()
      • mindoptpy.MdoModel.submit_task()
      • mindoptpy.MdoModel.write_prob()
      • mindoptpy.MdoModel.write_soln()
      • mindoptpy.MdoModel.write_task()
  • 8.3.8. MdoVar
    • mindoptpy.MdoVar
      • mindoptpy.MdoVar.get_index()
      • mindoptpy.MdoVar.get_int_attr()
      • mindoptpy.MdoVar.get_real_attr()
      • mindoptpy.MdoVar.get_str_attr()
      • mindoptpy.MdoVar.same_as()
      • mindoptpy.MdoVar.set_int_attr()
      • mindoptpy.MdoVar.set_real_attr()
      • mindoptpy.MdoVar.set_str_attr()
      • mindoptpy.MdoVar.get_soln_value()
  • 8.3.9. quicksum
    • quicksum()
• 8.4. Java API
• 8.5. Definitions
  • 8.5.1. Data types in C/C++
  • 8.5.2. Result Code
    • 8.5.2.1. Result Code in C/C++
    • 8.5.2.2. Python
  • 8.5.3. Solution code
    • 8.5.3.1. C/C++
    • 8.5.3.2. Python
  • 8.5.4. Alias of Attributes
  • 8.5.5. Constants
    • 8.5.5.1. C/C++
    • 8.5.5.2. Python
• 8.6. Optional input parameters
  • 8.6.1. Integer parameters
    • 8.6.1.1. “Method”
    • 8.6.1.2. “NumThreads”
    • 8.6.1.3. “Presolve”
    • 8.6.1.4. “Dualization”
    • 8.6.1.5. “SPX/MaxIterations”
    • 8.6.1.6. “SPX/ColumnGeneration”
    • 8.6.1.7. “SPX/CrashStart”
    • 8.6.1.8. “SPX/PrimalPricing”
    • 8.6.1.9. “SPX/DualPricing”
    • 8.6.1.10. “IPM/MaxIterations”
    • 8.6.1.11. “EnableNetworkFlow”
    • 8.6.1.12. “EnableStochasticLP”
    • 8.6.1.13. “MIP/MaxNodes”
    • 8.6.1.14. “MIP/RootParallelism”
    • 8.6.1.15. “MIP/AutoConfiguration”
    • 8.6.1.16. “MIP/MaxStallingNodes”
    • 8.6.1.17. “MIP/MaxSols”
    • 8.6.1.18. “MIP/DetectDisconnectedComponents”
    • 8.6.1.19. “MIP/SolutionPoolSize”
    • 8.6.1.20. “MIP/AllowDualPresolve”
  • 8.6.2. Real-number parameters
    • 8.6.2.1. “MaxTime”
    • 8.6.2.2. “SPX/PrimalTolerance”
    • 8.6.2.3. “SPX/DualTolerance”
    • 8.6.2.4. “IPM/PrimalTolerance”
    • 8.6.2.5. “IPM/DualTolerance”
    • 8.6.2.6. “IPM/GapTolerance”
    • 8.6.2.7. “MIP/IntegerTolerance”
    • 8.6.2.8. “MIP/ObjectiveTolerance”
    • 8.6.2.9. “MIP/GapAbs”
    • 8.6.2.10. “MIP/GapRel”
    • 8.6.2.11. “MIP/LinearizationBigM”
    • 8.6.2.12. “MIP/Cutoff”
  • 8.6.3. String parameters
    • 8.6.3.1. “Remote/Token”
    • 8.6.3.2. “Remote/Desc”
    • 8.6.3.3. “Remote/Server”
    • 8.6.3.4. “Remote/File/Model”
    • 8.6.3.5. “Remote/File/Param”
    • 8.6.3.6. “Remote/File/Soln”
    • 8.6.3.7. “Remote/File/Path”
• 8.7. Attributes during modeling and solving
  • 8.7.1. Model attributes
    • 8.7.1.1. “ProbName”
    • 8.7.1.2. “MinSense”
    • 8.7.1.3. “ObjConst”
    • 8.7.1.4. “NumVars”
    • 8.7.1.5. “NumConss”
    • 8.7.1.6. “NumEnts”
    • 8.7.1.7. “LB”
    • 8.7.1.8. “UB”
    • 8.7.1.9. “Obj”
    • 8.7.1.10. “LHS”
    • 8.7.1.11. “RHS”
    • 8.7.1.12. “ColName”
    • 8.7.1.13. “RowName”
    • 8.7.1.14. “IsInteger”
    • 8.7.1.15. “RowIIS”
    • 8.7.1.16. “ColIIS”
  • 8.7.2. Solution attributes
    • 8.7.2.1. “SolutionTime”
    • 8.7.2.2. “PresolverTime”
    • 8.7.2.3. “SolverTime”
    • 8.7.2.4. “HasSolution”
    • 8.7.2.5. “HasPrimalRay”
    • 8.7.2.6. “HasDualRay”
    • 8.7.2.7. “PrimalObjVal”
    • 8.7.2.8. “DualObjVal”
    • 8.7.2.9. “PrimalSoln”
    • 8.7.2.10. “DualSoln”
    • 8.7.2.11. “ColBasis”
    • 8.7.2.12. “RowBasis”
    • 8.7.2.13. “Activity”
    • 8.7.2.14. “ReducedCost”
    • 8.7.2.15. “SymMatPrimalSoln”
    • 8.7.2.16. “MIP/GapAbs”
    • 8.7.2.17. “MIP/GapRel”
  • 8.7.3. Simplex method attributes
    • 8.7.3.1. “SPX/NumIters”
  • 8.7.4. IPM attributes
    • 8.7.4.1. “IPM/NumIters”