cplexPtr-class: Class '"cplexPtr"'

In cplexAPI: R Interface to C API of IBM ILOG CPLEX

Description

Structure of the class "cplexPtr". Objects of that class are used to hold pointers to C structures used by IBM ILOG CPLEX.

Objects from the Class

Objects can be created by calls of the form
env <- openEnvCPLEX() and/or
prob <- initProbCPLEX(env)).

Slots

cplexPtrType:

Object of class "character" giving the pointer type.

cplexPointer:

Object of class "externalptr" containig the pointer to a C structure.

Methods

isCPLEXchanPointer

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a pointer to a CPLEX channel, otherwise FALSE.

isCPLEXenvPointer

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a pointer to a CPLEX environment, otherwise FALSE.

isCPLEXfilePointer

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a pointer to a CPLEX file, otherwise FALSE.

isCPLEXprobPointer

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a pointer to a CPLEX problem object, otherwise FALSE.

isCPLEXtermPointer

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a pointer to a CPLEX termination signal, otherwise FALSE.

isNULLpointerCPLEX

signature(object = "cplexPtr"): returns TRUE if cplexPointer(object) is a NULL pointer, otherwise FALSE.

cplexPointer

signature(object = "cplexPtr"): gets the cplexPointer slot.

summary

signature(object = "cplexPtr"): prints a summary of the problem object to the command line. If a solution is available, it prints also information retrieved by solutionCPLEX and solnInfoCPLEX. If no solution is available, it prints the corresponding error message. The method returns invisibly NULL. The CPLEX environment pointer is needed as second argument env to summary.

cplexPtrType

signature(object = "cplexPtr"): gets the cplexPtrType slot.

cplexPtrType<-

signature(object = "cplexPtr"): sets the cplexPtrType slot.

Author(s)

Gabriel Gelius-Dietrich <[e-mail]>

Maintainer: Mayo Roettger <[e-mail]>

References

The IBM ILOG CPLEX home page at https://www.ibm.com/support/knowledgecenter/SSSA5P.

See Also

openEnvCPLEX and initProbCPLEX

cplexAPI documentation built on Oct. 23, 2020, 5:45 p.m.