Cardinal Optimizer (COPT) User Guide

Contents

• Introduction to Cardinal Optimizer
  • Overview
  • Licenses
  • How to Cite
  • Contact Information
• Installation Guide
  • Registration
  • Software Installation
    • Windows
    • MacOS
    • Linux
  • Setting Up License
    • Obtaining License
    • Verifying License
    • Installing License
    • Others
  • Verify the installation and configuration
  • Upgrade
• COPT Command-Line
  • Overview
  • Edit mode
  • Script mode
  • Shell commands
    • General shell commands
    • COPT shell commands
  • Example Usage
• COPT Floating Licensing service
  • Server Setup
    • Installation
    • Floating License
    • Configuration
    • Web License for Floating Server
    • Example Usage
  • Client Setup
    • Configuration
    • Example Usage
  • Floating Token Server Managing Tool
    • Tool Usage
    • Example Usage
  • Running as service
    • Linux
    • MacOS
• COPT Compute Cluster Service
  • Server Setup
    • Installation
    • Cluster License
    • Configuration
    • Web License for Compute Cluster
    • Example Usage
  • Client Setup
    • Configuration
    • Example Usage
  • COPT Cluster Managing Tool
    • Tool Usage
    • Example Usage
  • Running as service
    • Linux
    • MacOS
• COPT Web Licensing Service
• COPT Quick Start
  • C Interface
    • Example details
    • Build and run
  • C++ Interface
    • Example details
    • Build and Run
  • C# Interface
    • Example details
    • Build and Run
  • Java Interface
    • Example details
    • Build and Run
  • Python Interface
    • Installation guide
    • Example details
    • Best Practice
  • AMPL Interface
    • Installation Guide
    • Solver Options and Exit Codes
    • Example Usage
  • Pyomo Interface
    • Installation Guide
    • Example Usage
  • PuLP Interface
    • Installation guide
    • Setup PuLP interface
    • Introduction of features
  • CVXPY Interface
    • Installation guide
    • Setup CVXPY interface
    • Introduction of features
• General Constants
  • Version information
  • Optimization directions
  • Infinity and Undefined Value
  • Constraint senses
  • Variable types
  • SOS-constraint types
  • Indicator constraint
  • Second-Order-Cone constraint
  • Quadratic objective function
  • Quadratic constraint
  • Basis status
  • Solution status
  • Client configuration
  • Callback context
  • Methods for accessing constants
• Attributes
  • Problem related
  • Solution related
  • Methods for accessing attributes
• Information
  • Problem information
  • Solution information
  • Dual Farkas and primal ray
  • Feasibility relaxation information
  • Callback information
  • Methods for accessing information
• Parameters
  • Limits and tolerances
  • Presolving and scaling
  • Linear programming related
  • Semidefinite programming related
  • Integer programming related
  • Parallel computing related
  • GPU computing related
  • IIS computation related
  • Feasibility relaxation related
  • Parameter Tuning related
  • Callback related
  • Other parameters
  • Methods for accessing and setting parameters
• MIP Starts
  • Utilities of MIP Starts
    • Set and Load MIP Starts
    • Read and Write MIP Starts
  • Related Parameters
  • Log of MIP starts
    • MIP starts are accepted
    • MIP starts are rejected
• MIP Solution Pool
• COPT Tuner
  • Introduction
  • Related parameters
  • Provided capabilities
    • Tuning method
    • Tuning mode
    • Tuning permutations
    • Tuning measure
    • Tuning targets
    • Tuning output
    • TuneTimeLimit
    • User defined parts
    • Load or writing tuning parameter
  • Example
• Callbacks
  • Obtaining information during the solving process
  • Controlling the MIP solving process
    • Adding lazy constraints
    • Adding cutting planes
    • Adding feasible solutions
  • Using the callback utilities in different APIs
• Matrix Modeling Method
  • Multi-dimensional Variables
  • Multi-dimensional array operations and expressions
    • Multi-dimensional Linear Expressions
    • Multi-dimensional Quadratic Expression
    • Other multi-dimensional array operations
  • Matrix Constraints
    • Matrix linear Constraints
    • Quadratic Constraints
  • Objective function composed of multi-dimensional variables
• Logging
  • Parameters and Functions for Logging
  • Basic Information
  • Simplex Method Logging
    • Presolve
    • Simplex iteration process
    • Summary of Optimization Results
  • Barrier Method Logging
    • Presolve
    • Model Information
  • Branch-and-Cut Method Logging
    • Presolve
    • Branch-and-Cut Search Process
    • Summary of Results
  • Logging for First-order method (PDLP) of GPU solver
    • GPU hardware information of the machine
    • 3. First-order method PULP iteration process
• File formats
  • File format list
  • File I/O operations
  • Model file introduction
• FAQs
  • Installation and Licensing Configuration Related
    • MacOS System
    • Windows System
  • Modeling and Solving Functions Related
  • GPU Usage Related
• C API Reference
  • Constants
    • Optimization directions
    • Infinity
    • Undefined Value
    • Constraint senses
    • Variable types
    • SOS-constraint types
    • Indicator constraint
    • Second-Order-Cone constraint
    • Quadratic objective function
    • Quadratic constraint
    • Basis status
    • LP solution status
    • MIP solution status
    • Callback context
    • API function return code
    • Client configuration
    • Other constants
  • Attributes
    • Problem information
    • Solution information
  • Information
    • Problem information
    • Solution information
    • Dual Farkas and primal ray
    • Feasibility relaxation information
  • Callback information
  • Parameters
    • Limits and tolerances
    • Presolving and scaling
    • Linear programming related
    • Semidefinite programming related
    • Integer programming related
    • Parallel computing related
    • IIS computation related
    • Feasibility relaxation related
    • Tuner related
    • Callback related
    • GPU computing related
    • Other parameters
  • API Functions
    • Creating the environment and problem
    • Building and modifying a problem
    • Reading and writing the problem
    • Solving the problem and accessing solutions
    • Accessing information of problem
    • Accessing and setting parameters
    • Accessing attributes
    • Logging utilities
    • MIP start utilities
    • IIS utilities
    • Feasibility relaxation utilities
    • Parameter tuning utilities
    • Callback utilities
    • Other API functions
• Python API Reference
  • Constants
    • General Constants
    • Attributes
    • Information
    • Callback Information
    • Parameters
  • Python Modeling Classes
    • EnvrConfig Class
    • Envr Class
    • Model Class
    • Var Class
    • VarArray Class
    • PsdVar Class
    • PsdVarArray Class
    • SymMatrix Class
    • SymMatrixArray Class
    • Constraint Class
    • ConstrArray Class
    • ConstrBuilder Class
    • ConstrBuilderArray Class
    • QConstraint Class
    • QConstrArray Class
    • QConstrBuilder Class
    • QConstrBuilderArray Class
    • PsdConstraint Class
    • PsdConstrArray Class
    • PsdConstrBuilder Class
    • PsdConstrBuilderArray Class
    • LmiConstraint Class
    • LmiConstrArray Class
    • SOS Class
    • SOSArray Class
    • SOSBuilder Class
    • SOSBuilderArray Class
    • Cone Class
    • ConeArray Class
    • ConeBuilder Class
    • ConeBuilderArray Class
    • GenConstr Class
    • GenConstrArray Class
    • GenConstrBuilder Class
    • GenConstrBuilderArray Class
    • Column Class
    • ColumnArray Class
    • MVar Class
    • MConstr Class
    • MConstrBuilder Class
    • MQConstrBuilder Class
    • MLinExpr Class
    • MQuadExpr Class
    • ExprBuilder Class
    • LinExpr Class
    • QuadExpr Class
    • PsdExpr Class
    • LmiExpr Class
    • CallbackBase Class
    • GenConstrX Class
    • CoptError Class
  • Helper Functions and Utilities
    • Helper Functions
    • tuplelist Class
    • tupledict Class
    • ProbBuffer Class
• C++ API Reference
  • Constants
  • Attributes
  • Information
  • Parameters
  • C++ Modeling Classes
    • Envr
    • EnvrConfig
    • Model
    • Var
    • VarArray
    • Expr
    • Constraint
    • ConstrArray
    • ConstrBuilder
    • ConstrBuilderArray
    • Column
    • ColumnArray
    • Sos
    • SosArray
    • SosBuilder
    • SosBuilderArray
    • GenConstr
    • GenConstrArray
    • GenConstrBuilder
    • GenConstrBuilderArray
    • Cone
    • ConeArray
    • ConeBuilder
    • ConeBuilderArray
    • QuadExpr
    • QConstraint
    • QConstrArray
    • QConstrBuilder
    • QConstrBuilderArray
    • PsdVar
    • PsdVarArray
    • PsdExpr
    • PsdConstraint
    • PsdConstrArray
    • PsdConstrBuilder
    • PsdConstrBuilderArray
    • LmiConstraint
    • LmiConstrArray
    • LmiExpr
    • SymMatrix
    • SymMatrixArray
    • SymMatExpr
    • CallbackBase
    • ProbBuffer
• C# API Reference
  • Constants
    • General Constants
    • Attributes
    • Information
    • Callback Information
    • Parameters
  • C# Modeling Classes
    • Envr
    • EnvrConfig
    • Model
    • Var
    • VarArray
    • Expr
    • Constraint
    • ConstrArray
    • ConstrBuilder
    • ConstrBuilderArray
    • Column
    • ColumnArray
    • Sos
    • SosArray
    • SosBuilder
    • SosBuilderArray
    • GenConstr
    • GenConstrArray
    • GenConstrBuilder
    • GenConstrBuilderArray
    • Cone
    • ConeArray
    • ConeBuilder
    • ConeBuilderArray
    • QuadExpr
    • QConstraint
    • QConstrArray
    • QConstrBuilder
    • QConstrBuilderArray
    • PsdVar
    • PsdVarArray
    • PsdExpr
    • PsdConstraint
    • PsdConstrArray
    • PsdConstrBuilder
    • PsdConstrBuilderArray
    • LmiConstraint
    • LmiConstrArray
    • LmiExpr
    • SymMatrix
    • SymMatrixArray
    • SymMatExpr
    • CallbackBase
    • ProbBuffer
    • CoptException
• Java API Reference
  • Constants
    • General Constants
    • Attributes
    • Information
    • Callback Information
    • Parameters
  • Java Modeling Classes
    • Envr
    • EnvrConfig
    • Model
    • Var
    • VarArray
    • Expr
    • Constraint
    • ConstrArray
    • ConstrBuilder
    • ConstrBuilderArray
    • Column
    • ColumnArray
    • Sos
    • SosArray
    • SosBuilder
    • SosBuilderArray
    • GenConstr
    • GenConstrArray
    • GenConstrBuilder
    • GenConstrBuilderArray
    • Cone
    • ConeArray
    • ConeBuilder
    • ConeBuilderArray
    • QuadExpr
    • QConstraint
    • QConstrArray
    • QConstrBuilder
    • QConstrBuilderArray
    • PsdVar
    • PsdVarArray
    • PsdExpr
    • PsdConstraint
    • PsdConstrArray
    • PsdConstrBuilder
    • PsdConstrBuilderArray
    • LmiConstraint
    • LmiConstrArray
    • LmiExpr
    • SymMatrix
    • SymMatrixArray
    • SymMatExpr
    • CallbackBase
    • ProbBuffer
    • CoptException