Package cplex :: Package _internal :: Module _procedural

Module _procedural

Wrapper functions for the CPLEX C Callable Library

Classes
	SigIntHandler Handle Ctrl-C events during long running processes.
	StatusChecker A callable object used for checking status codes.

Functions

getstatstring(env, statind)

geterrorstring(env, errcode)

cb_geterrorstring(env, status)

new_native_int()

delete_native_int(p)

set_native_int(p, v)

get_native_int(p)

setterminate(env, env_lp_ptr, p)

pack_env_lp_ptr(env, lp)

chbmatrix(*args, **kwds)
See matrix_conversion.c:Pylolmat_to_CHBmat().

Pylolmat_to_CHBmat(lolmat, env_lp_ptr, r_c)

free_CHBmat(lolmat)

set_status_checker()

version(env)

versionnumber(env)

openCPLEX()

closeCPLEX(env)

getchannels(env)

addfuncdest(env, channel, fileobj)

delfuncdest(env, channel, fileobj)

setlpcallbackfunc(env, cbhandle)

setnetcallbackfunc(env, cbhandle)

settuningcallbackfunc(env, cbhandle)

setheuristiccallbackfunc(env, cbhandle)

setlazyconstraintcallbackfunc(env, cbhandle)

setusercutcallbackfunc(env, cbhandle)

setincumbentcallbackfunc(env, cbhandle)

setnodecallbackfunc(env, cbhandle)

setbranchcallbackfunc(env, cbhandle)

setbranchnosolncallbackfunc(env, cbhandle)

setsolvecallbackfunc(env, cbhandle)

setinfocallbackfunc(env, cbhandle)

setmipcallbackfunc(env, cbhandle)

setdefaults(env)

setintparam(env, whichparam, newvalue)

setlongparam(env, whichparam, newvalue)

setdblparam(env, whichparam, newvalue)

setstrparam(env, whichparam, newvalue)

getintparam(env, whichparam)

getlongparam(env, whichparam)

getdblparam(env, whichparam)

getstrparam(env, whichparam)

infointparam(env, whichparam)

infolongparam(env, whichparam)

infodblparam(env, whichparam)

infostrparam(env, whichparam)

getparamtype(env, param_name)

readcopyparam(env, filename)

writeparam(env, filename)

tuneparam(env, lp, int_param_values, dbl_param_values, str_param_values)

tuneparamprobset(env, filenames, filetypes, int_param_values, dbl_param_values, str_param_values)

fixparam(env, paramnum)

paramsetadd(env, ps, whichparam, newvalue, paramtype=None)

paramsetadddbl(env, ps, whichparam, newvalue)

paramsetaddint(env, ps, whichparam, newvalue)

paramsetaddlong(env, ps, whichparam, newvalue)

paramsetaddstr(env, ps, whichparam, newvalue)

paramsetapply(env, ps)

paramsetcopy(env, targetps, sourceps)

paramsetcreate(env)

paramsetdel(env, ps, whichparam)

paramsetfree(env, ps)

paramsetget(env, ps, whichparam, paramtype=None)

paramsetgetdbl(env, ps, whichparam)

paramsetgetint(env, ps, whichparam)

paramsetgetlong(env, ps, whichparam)

paramsetgetstr(env, ps, whichparam)

paramsetgetids(env, ps)

paramsetreadcopy(env, ps, filename)

paramsetwrite(env, ps, filename)

paramsetgetnum(env, ps)

runseeds(env, lp, cnt)

createprob(env, probname)

readcopyprob(env, lp, filename, filetype='')

cloneprob(env, lp)

freeprob(env, lp)

mipopt(env, lp)

qpopt(env, lp)

baropt(env, lp)

hybbaropt(env, lp, method)

hybnetopt(env, lp, method)

lpopt(env, lp)

primopt(env, lp)

dualopt(env, lp)

siftopt(env, lp)

feasoptext(env, lp, grppref, grpbeg, grpind, grptype)

delnames(env, lp)

writeprob(env, lp, filename, filetype='')

writeprobdev(env, lp, stream, filename, filetype)

embwrite(env, lp, filename)

dperwrite(env, lp, filename, epsilon)

pperwrite(env, lp, filename, epsilon)

preslvwrite(env, lp, filename)

dualwrite(env, lp, filename)

chgprobtype(env, lp, probtype)

chgprobtypesolnpool(env, lp, probtype, soln)

getprobtype(env, lp)

chgprobname(env, lp, probname)

getprobname(env, lp)

getnumcols(env, lp)

getnumint(env, lp)

getnumbin(env, lp)

getnumsemicont(env, lp)

getnumsemiint(env, lp)

getnumrows(env, lp)

populate(env, lp)

getnumqconstrs(env, lp)

getnumindconstrs(env, lp)

getnumsos(env, lp)

cleanup(env, lp, eps)

basicpresolve(env, lp)

pivotin(env, lp, rlist)

pivotout(env, lp, clist)

pivot(env, lp, jenter, jleave, leavestat)

strongbranch(env, lp, goodlist, itlim)

completelp(env, lp)

fast_getrows(*args, **kwds)

fast_getcolname(*args, **kwds)

fast_getrowname(*args, **kwds)

fast_getsosname(*args, **kwds)

fast_getmipstartname(*args, **kwds)

fast_getobj(*args, **kwds)

fast_multiobjgetobj(*args, **kwds)

fast_multiobjgetoffset(env, lp, objidx)

fast_multiobjgetweight(env, lp, objidx)

fast_multiobjgetpriority(env, lp, objidx)

fast_multiobjgetabstol(env, lp, objidx)

fast_multiobjgetreltol(env, lp, objidx)

fast_newcols(env, lp, nb, lb, ub, xctype)

has_name(env, lp, start, end)

has_non_default_lb(env, lp, start, end)

has_non_default_ub(env, lp, start, end)

newcols(env, lp, obj, lb, ub, xctype, colname)

addcols(env, lp, ccnt, nzcnt, obj, cmat, lb, ub, colname)

delcols(env, lp, begin, end)

chgbds(env, lp, indices, lu, bd)

chgcolname(env, lp, indices, newnames)

chgctype(env, lp, indices, xctype)

getcolindex(env, lp, colname)

getcolname(env, lp, begin, end)

getctype(env, lp, begin, end)

getlb(env, lp, begin, end)

getub(env, lp, begin, end)

getcols(env, lp, begin, end)

copyprotected(env, lp, indices)

getprotected(env, lp)

tightenbds(env, lp, indices, lu, bd)

newrows(env, lp, rhs, sense, rngval, rowname)

addrows(env, lp, ccnt, rcnt, nzcnt, rhs, sense, rmat, colname, rowname)

delrows(env, lp, begin, end)

chgrowname(env, lp, indices, newnames)

chgcoeflist(env, lp, rowlist, collist, vallist)

chgrhs(env, lp, indices, values)

chgrngval(env, lp, indices, values)

chgsense(env, lp, indices, senses)

getrhs(env, lp, begin, end)

getsense(env, lp, begin, end)

getrngval(env, lp, begin, end)

getrowname(env, lp, begin, end)

getcoef(env, lp, i, j)

getrowindex(env, lp, rowname)

getrows(env, lp, begin, end)

getnumnz(env, lp)

addlazyconstraints(env, lp, rhs, sense, lin_expr, names)

addusercuts(env, lp, rhs, sense, lin_expr, names)

freelazyconstraints(env, lp)

freeusercuts(env, lp)

copylpwnames(env, lp, numcols, numrows, objsense, obj, rhs, sense, matbeg, matcnt, matind, matval, lb, ub, rngval, colname, rowname)

addsos(env, lp, sostype, sosbeg, sosind, soswt, sosnames)

delsos(env, lp, begin, end)

getsos_info(env, lp, begin, end)

getsos(env, lp, begin, end)

getsosindex(env, lp, name)

getsosname(env, lp, begin, end)

addindconstr(env, lp, indcnt, indvar, complemented, rhs, sense, linmat, indtype, name, nzcnt)

getindconstr(env, lp, begin, end)

getindconstr_constant(env, lp, begin, end)

getindconstrindex(env, lp, name)

delindconstrs(env, lp, begin, end)

getindconstrslack(env, lp, begin, end)

getindconstrname(env, lp, which)

addqconstr(env, lp, rhs, sense, linind, linval, quadrow, quadcol, quadval, name)

getqconstr_info(env, lp, which)

getqconstr_lin(env, lp, which)

getqconstr_quad(env, lp, which)

delqconstrs(env, lp, begin, end)

getqconstrindex(env, lp, name)

getqconstrslack(env, lp, begin, end)

getqconstrname(env, lp, which)

newlonganno(env, lp, name, defval)

newdblanno(env, lp, name, defval)

dellonganno(env, lp, begin, end)

deldblanno(env, lp, begin, end)

getlongannoindex(env, lp, name)

getdblannoindex(env, lp, name)

getlongannoname(env, lp, idx)

getdblannoname(env, lp, idx)

getnumlonganno(env, lp)

getnumdblanno(env, lp)

getlongannodefval(env, lp, idx)

getdblannodefval(env, lp, idx)

setlonganno(env, lp, idx, objtype, ind, val)

setdblanno(env, lp, idx, objtype, ind, val)

getlonganno(env, lp, idx, objtype, begin, end)

getdblanno(env, lp, idx, objtype, begin, end)

readcopyanno(env, lp, filename)

writeanno(env, lp, filename)

writebendersanno(env, lp, filename)

addpwl(env, lp, vary, varx, preslope, postslope, nbreaks, breakx, breaky, name)

delpwl(env, lp, begin, end)

getnumpwl(env, lp)

getpwl(env, lp, idx)

getpwlindex(env, lp, name)

getpwlname(env, lp, idx)

copyobjname(env, lp, objname)

chgobj(env, lp, indices, values)

chgobjsen(env, lp, maxormin)

getobjsen(env, lp)

getobjoffset(env, lp)

chgobjoffset(env, lp, offset)

getobj(env, lp, begin, end)

getobjname(env, lp)

copyquad(env, lp, qmatbeg, qmatind, qmatval)

copyqpsep(env, lp, qsepvec)

chgqpcoef(env, lp, row, col, value)

getquad(env, lp, begin, end)

getqpcoef(env, lp, row, col)

getnumquad(env, lp)

getnumqpnz(env, lp)

getnumobjs(env, lp)

multiobjchgattribs(env, lp, objidx, offset=nan, weight=nan, priority=-1, abstol=nan, reltol=nan, name=None)

multiobjgetindex(env, lp, name)

multiobjgetname(env, lp, objidx)

multiobjgetobj(env, lp, objidx, begin, end)

multiobjsetobj(env, lp, objidx, objind, objval, offset=nan, weight=nan, priority=-1, abstol=nan, reltol=nan, objname=None)

setnumobjs(env, lp, n)

multiobjopt(env, lp, paramsets)

multiobjgetobjval(env, lp, objidx)

multiobjgetobjvalbypriority(env, lp, priority)

multiobjgetdblinfo(env, lp, subprob, what)

multiobjgetintinfo(env, lp, subprob, what)

multiobjgetlonginfo(env, lp, subprob, what)

multiobjgetnumsolves(env, lp)

getnumprios(env, lp)

ismultiobj(env, lp)

solninfo(env, lp)

getstat(env, lp)

getmethod(env, lp)

getobjval(env, lp)

getx(env, lp, begin, end)

getnumcores(env)

getax(env, lp, begin, end)

getxqxax(env, lp, begin, end)

getpi(env, lp, begin, end)

getslack(env, lp, begin, end)

getdj(env, lp, begin, end)

getqconstrdslack(env, lp, qind)

getrowinfeas(env, lp, x, begin, end)

getcolinfeas(env, lp, x, begin, end)

getqconstrinfeas(env, lp, x, begin, end)

getindconstrinfeas(env, lp, x, begin, end)

getsosinfeas(env, lp, x, begin, end)

getbase(env, lp)

getbhead(env, lp)

mbasewrite(env, lp, filename)

getijrow(env, lp, idx, is_row_index)

getpnorms(env, lp)

getdnorms(env, lp)

getbasednorms(env, lp)

getpsbcnt(env, lp)

getdsbcnt(env, lp)

getdblquality(env, lp, what)

getintquality(env, lp, what)

boundsa_lower(env, lp, begin, end)

boundsa_upper(env, lp, begin, end)

boundsa(env, lp, begin, end)

objsa(env, lp, begin, end)

rhssa(env, lp, begin, end)

refinemipstartconflictext(env, lp, mipstartindex, grppref, grpbeg, grpind, grptype)

refineconflictext(env, lp, grppref, grpbeg, grpind, grptype)

getconflictext(env, lp, begin, end)

getconflictnumgroups(env, lp)

getconflictgroups(env, lp, begin, end)

getconflictnumpasses(env, lp)

clpwrite(env, lp, filename)

solwrite(env, lp, filename)

binvcol(env, lp, j)

binvrow(env, lp, i)

binvacol(env, lp, j)

binvarow(env, lp, i)

ftran(env, lp, x)

btran(env, lp, y)

getgrad(env, lp, j)

slackfromx(env, lp, x)

qconstrslackfromx(env, lp, x)

djfrompi(env, lp, pi)

qpdjfrompi(env, lp, pi, x)

mdleave(env, lp, goodlist)

qpindefcertificate(env, lp)

dualfarkas(env, lp)

getijdiv(env, lp)

getray(env, lp)

presolve(env, lp, method)

freepresolve(env, lp)

crushx(env, lp, x)

uncrushx(env, lp, prex)

crushpi(env, lp, pi)

uncrushpi(env, lp, prepi)

crushform(env, lp, ind, val)

uncrushform(env, lp, pind, pval)

getprestat_status(env, lp)

getprestat_r(env, lp)

getprestat_c(env, lp)

getprestat_or(env, lp)

getprestat_oc(env, lp)

prechgobj(env, lp, ind, val)

preaddrows(env, lp, rhs, sense, rmatbeg, rmatind, rmatval, names)

getnummipstarts(env, lp)

chgmipstarts(env, lp, mipstartindices, beg, varindices, values, effortlevel)

addmipstarts(env, lp, beg, varindices, values, effortlevel, mipstartname)

delmipstarts(env, lp, begin, end)

getmipstarts_size(env, lp, begin, end)

getmipstarts_effort(env, lp, begin, end)

getmipstarts(env, lp, begin, end)

getmipstartname(env, lp, begin, end)

getmipstartindex(env, lp, mipstartname)

readcopymipstarts(env, lp, filename)

writemipstarts(env, lp, filename, begin, end)

getitcnt(env, lp)

getphase1cnt(env, lp)

getsiftitcnt(env, lp)

getsiftphase1cnt(env, lp)

getbaritcnt(env, lp)

getcrossppushcnt(env, lp)

getcrosspexchcnt(env, lp)

getcrossdpushcnt(env, lp)

getcrossdexchcnt(env, lp)

getmipitcnt(env, lp)

getnodecnt(env, lp)

getnodeleftcnt(env, lp)

getbestobjval(env, lp)

getcutoff(env, lp)

getmiprelgap(env, lp)

getnumcuts(env, lp, cuttype)

getnodeint(env, lp)

getsubstat(env, lp)

get_wherefrom(cbstruct)

gettime(env)

getdettime(env)

getcallbackincumbent(cbstruct, begin, end)

getcallbackpseudocosts(cbstruct, begin, end)

getcallbacknodeintfeas(cbstruct, begin, end)

getcallbacknodelb(cbstruct, begin, end)

getcallbacknodeub(cbstruct, begin, end)

getcallbacknodeobjval(cbstruct)

getcallbacknodex(cbstruct, begin, end)

getcallbacknodeinfo(cbstruct, node, which)

callbacksetuserhandle(cbstruct, userhandle)

callbacksetnodeuserhandle(cbstruct, nodeindex, userhandle)

getcallbackseqinfo(cbstruct, node, which)

getcallbacksosinfo(cbstruct, sosindex, member, which)

cutcallbackadd(cbstruct, rhs, sense, ind, val, purgeable)

cutcallbackaddlocal(cbstruct, rhs, sense, ind, val)

branchcallbackbranchgeneral(cbstruct, ind, lu, bd, rhs, sense, matbeg, matind, matval, nodeest, userhandle)

branchcallbackbranchasCPLEX(cbstruct, n, userhandle)

setpydel(env)

delpydel(env)

addsolnpooldivfilter(env, lp, lb, ub, ind, wts, ref, name)

addsolnpoolrngfilter(env, lp, lb, ub, ind, val, name)

getsolnpooldivfilter_constant(env, lp, which)

getsolnpooldivfilter(env, lp, which)

getsolnpoolrngfilter_constant(env, lp, which)

getsolnpoolrngfilter(env, lp, which)

delsolnpoolfilters(env, lp, begin, end)

getsolnpoolfiltername(env, lp, which)

getsolnpoolnumfilters(env, lp)

fltwrite(env, lp, filename)

readcopysolnpoolfilters(env, lp, filename)

getsolnpoolfilterindex(env, lp, colname)

getsolnpoolfiltertype(env, lp, index)

delsolnpoolsolns(env, lp, begin, end)

getsolnpoolnumsolns(env, lp)

getsolnpoolnumreplaced(env, lp)

getsolnpoolsolnindex(env, lp, colname)

getsolnpoolmeanobjval(env, lp)

getsolnpoolsolnname(env, lp, which)

solwritesolnpool(env, lp, soln, filename)

solwritesolnpoolall(env, lp, filename)

getsolnpoolobjval(env, lp, soln)

getsolnpoolx(env, lp, soln, begin, end)

getsolnpoolslack(env, lp, soln, begin, end)

getsolnpoolqconstrslack(env, lp, soln, begin, end)

getsolnpoolintquality(env, lp, soln, what)

getsolnpooldblquality(env, lp, soln, what)

copystart(env, lp, cstat, rstat, cprim, rprim, cdual, rdual)

readcopybase(env, lp, filename)

getorder(env, lp)

copyorder(env, lp, indices, priority, direction)

readcopyorder(env, lp, filename)

ordwrite(env, lp, filename)

readcopystartinfo(env, lp, filename)

initlock()

finitlock(lock)

getprobstats(env, lp)

gethist(env, lp, key)

getqualitymetrics(env, lp, soln)

showquality(env, lp, soln)

setgenericcallbackfunc(env, lp, contextmask, cbhandle)

callbackgetinfoint(contextptr, which)

callbackgetinfolong(contextptr, which)

callbackgetinfodbl(contextptr, which)

callbackabort(contextptr)

callbackcandidateispoint(contextptr)

callbackgetcandidatepoint(contextptr, begin, end)

callbackcandidateisray(contextptr)

callbackgetcandidateray(contextptr, begin, end)

callbackgetcandidateobj(contextptr)

callbackgetrelaxationpoint(contextptr, begin, end)

callbackgetrelaxationpointobj(contextptr)

callbackgetrelaxationstatus(contextptr, flags)

callbackmakebranch(contextptr, ind, lu, bd, rhs, sense, matbeg, matind, matval, nodeest)

callbackprunenode(contextptr)

callbackexitcutloop(contextptr)

callbackgetincumbent(contextptr, begin, end)

callbackgetincumbentobj(contextptr)

callbackgetlocallb(contextptr, begin, end)

callbackgetlocalub(contextptr, begin, end)

callbackgetgloballb(contextptr, begin, end)

callbackgetglobalub(contextptr, begin, end)

callbackpostheursoln(contextptr, cnt, ind, val, obj, strategy)

callbackaddusercuts(contextptr, rcnt, nzcnt, rhs, sense, rmat, cutmanagement, local)

callbackrejectcandidate(contextptr, rcnt, nzcnt, rhs, sense, rmat)

callbackrejectcandidatelocal(contextptr, rcnt, nzcnt, rhs, sense, rmat)

modelasstcallbacksetfunc(env, lp, cbhandle)

Variables
	CPLEX_PY_DISABLE_SIGHANDLER = `None`
	check_status = `StatusChecker()`
	cpxlong_callback_node_info = `[220, 221, 222]`
	int_callback_node_info = `[202, 207, 208, 143]`
	double_callback_node_info = `[201, 203, 205]`
	user_handle_callback_node_info = `[210]`
	int_sos_info = `[247, 241, 242, 244]`
	double_sos_info = `[246]`

Function Details

chbmatrix(*args, **kwds)

See matrix_conversion.c:Pylolmat_to_CHBmat().

Decorators:

@contextmanager

fast_getrows(*args, **kwds)

Decorators:

@contextmanager

fast_getcolname(*args, **kwds)

Decorators:

@contextmanager

fast_getrowname(*args, **kwds)

Decorators:

@contextmanager

fast_getsosname(*args, **kwds)

Decorators:

@contextmanager

fast_getmipstartname(*args, **kwds)

Decorators:

@contextmanager

fast_getobj(*args, **kwds)

Decorators:

@contextmanager

fast_multiobjgetobj(*args, **kwds)

Decorators:

@contextmanager