Row methods

Detailed Description

Functions
	SCIP_DECL_SORTPTRCOMP (SCIProwComp)
void	SCIProwLock (SCIP_ROW *row)
void	SCIProwUnlock (SCIP_ROW *row)
SCIP_Real	SCIProwGetScalarProduct (SCIP_ROW *row1, SCIP_ROW *row2)
SCIP_Real	SCIProwGetParallelism (SCIP_ROW *row1, SCIP_ROW *row2, char orthofunc)
SCIP_Real	SCIProwGetOrthogonality (SCIP_ROW *row1, SCIP_ROW *row2, char orthofunc)
void	SCIProwSort (SCIP_ROW *row)
int	SCIProwGetNNonz (SCIP_ROW *row)
int	SCIProwGetNLPNonz (SCIP_ROW *row)
SCIP_COL **	SCIProwGetCols (SCIP_ROW *row)
SCIP_Real *	SCIProwGetVals (SCIP_ROW *row)
SCIP_Real	SCIProwGetConstant (SCIP_ROW *row)
SCIP_Real	SCIProwGetNorm (SCIP_ROW *row)
SCIP_Real	SCIProwGetSumNorm (SCIP_ROW *row)
SCIP_Real	SCIProwGetLhs (SCIP_ROW *row)
SCIP_Real	SCIProwGetRhs (SCIP_ROW *row)
SCIP_Real	SCIProwGetDualsol (SCIP_ROW *row)
SCIP_Real	SCIProwGetDualfarkas (SCIP_ROW *row)
SCIP_BASESTAT	SCIProwGetBasisStatus (SCIP_ROW *row)
const char *	SCIProwGetName (SCIP_ROW *row)
int	SCIProwGetIndex (SCIP_ROW *row)
int	SCIProwGetAge (SCIP_ROW *row)
int	SCIProwGetRank (SCIP_ROW *row)
SCIP_Bool	SCIProwIsIntegral (SCIP_ROW *row)
SCIP_Bool	SCIProwIsLocal (SCIP_ROW *row)
SCIP_Bool	SCIProwIsModifiable (SCIP_ROW *row)
SCIP_Bool	SCIProwIsRemovable (SCIP_ROW *row)
SCIP_ROWORIGINTYPE	SCIProwGetOrigintype (SCIP_ROW *row)
SCIP_CONSHDLR *	SCIProwGetOriginCons (SCIP_ROW *row)
SCIP_SEPA *	SCIProwGetOriginSepa (SCIP_ROW *row)
SCIP_Bool	SCIProwIsInGlobalCutpool (SCIP_ROW *row)
int	SCIProwGetLPPos (SCIP_ROW *row)
int	SCIProwGetLPDepth (SCIP_ROW *row)
SCIP_Bool	SCIProwIsInLP (SCIP_ROW *row)
void	SCIProwChgRank (SCIP_ROW *row, int rank)

Function Documentation

SCIP_DECL_SORTPTRCOMP

(

SCIProwComp

)

comparison method for sorting rows by non-decreasing index

void SCIProwLock

(

SCIP_ROW *

row

)

locks an unmodifiable row, which forbids further changes; has no effect on modifiable rows

Parameters

row

LP row

void SCIProwUnlock

(

SCIP_ROW *

row

)

unlocks a lock of an unmodifiable row; a row with no sealed lock may be modified; has no effect on modifiable rows

Parameters

row

LP row

SCIP_Real SCIProwGetScalarProduct	(	SCIP_ROW *	row1,
		SCIP_ROW *	row2
	)

returns the scalar product of the coefficient vectors of the two given rows

Parameters

row1	first LP row
row2	second LP row

SCIP_Real SCIProwGetParallelism	(	SCIP_ROW *	row1,
		SCIP_ROW *	row2,
		char	orthofunc
	)

returns the degree of parallelism between the hyperplanes defined by the two row vectors v, w: p = |v*w|/(|v|*|w|); the hyperplanes are parallel, iff p = 1, they are orthogonal, iff p = 0

Parameters

row1	first LP row
row2	second LP row
orthofunc	function used for calc. scalar prod. ('e'uclidean, 'd'iscrete)

SCIP_Real SCIProwGetOrthogonality	(	SCIP_ROW *	row1,
		SCIP_ROW *	row2,
		char	orthofunc
	)

returns the degree of orthogonality between the hyperplanes defined by the two row vectors v, w: o = 1 - |v*w|/(|v|*|w|); the hyperplanes are orthogonal, iff p = 1, they are parallel, iff p = 0

Parameters

row1	first LP row
row2	second LP row
orthofunc	function used for calc. scalar prod. ('e'uclidean, 'd'iscrete)

void SCIProwSort

(

SCIP_ROW *

row

)

sorts row entries such that LP columns precede non-LP columns and inside both parts lower column indices precede higher ones

Parameters

row	row to be sorted

int SCIProwGetNNonz

(

SCIP_ROW *

row

)

get number of nonzero entries in row vector

Parameters

row

LP row

int SCIProwGetNLPNonz

(

SCIP_ROW *

row

)

get number of nonzero entries in row vector, that correspond to columns currently in the SCIP_LP;

Warning

This method is only applicable on rows, that are completely linked to their columns (e.g. a row that is in the current LP and the LP was solved, or a row that was in a solved LP and didn't change afterwards

Parameters

row

LP row

SCIP_COL** SCIProwGetCols

(

SCIP_ROW *

row

)

gets array with columns of nonzero entries

Parameters

row

LP row

SCIP_Real* SCIProwGetVals

(

SCIP_ROW *

row

)

gets array with coefficients of nonzero entries

Parameters

row

LP row

SCIP_Real SCIProwGetConstant

(

SCIP_ROW *

row

)

gets constant shift of row

Parameters

row

LP row

SCIP_Real SCIProwGetNorm

(

SCIP_ROW *

row

)

gets Euclidean norm of row vector

Parameters

row

LP row

SCIP_Real SCIProwGetSumNorm

(

SCIP_ROW *

row

)

gets sum norm of row vector (sum of absolute values of coefficients)

Parameters

row

LP row

SCIP_Real SCIProwGetLhs

(

SCIP_ROW *

row

)

returns the left hand side of the row

Parameters

row

LP row

SCIP_Real SCIProwGetRhs

(

SCIP_ROW *

row

)

returns the right hand side of the row

Parameters

row

LP row

SCIP_Real SCIProwGetDualsol

(

SCIP_ROW *

row

)

gets the dual LP solution of a row

Parameters

row

LP row

SCIP_Real SCIProwGetDualfarkas

(

SCIP_ROW *

row

)

gets the dual Farkas coefficient of a row in an infeasible LP

Parameters

row

LP row

SCIP_BASESTAT SCIProwGetBasisStatus

(

SCIP_ROW *

row

)

gets the basis status of a row in the LP solution; only valid for LPs with status SCIP_LPSOLSTAT_OPTIMAL and with SCIPisLPSolBasic(scip) == TRUE; returns SCIP_BASESTAT_BASIC for rows not in the current SCIP_LP

Parameters

row

LP row

const char* SCIProwGetName

(

SCIP_ROW *

row

)

returns the name of the row

Parameters

row

LP row

int SCIProwGetIndex

(

SCIP_ROW *

row

)

gets unique index of row

Parameters

row

LP row

int SCIProwGetAge

(

SCIP_ROW *

row

)

gets age of row

Parameters

row

LP row

int SCIProwGetRank

(

SCIP_ROW *

row

)

gets rank of row

Parameters

row

LP row

SCIP_Bool SCIProwIsIntegral

(

SCIP_ROW *

row

)

returns TRUE iff the activity of the row (without the row's constant) is always integral in a feasible solution

Parameters

row

LP row

SCIP_Bool SCIProwIsLocal

(

SCIP_ROW *

row

)

returns TRUE iff row is only valid locally

Parameters

row

LP row

SCIP_Bool SCIProwIsModifiable

(

SCIP_ROW *

row

)

returns TRUE iff row is modifiable during node processing (subject to column generation)

Parameters

row

LP row

SCIP_Bool SCIProwIsRemovable

(

SCIP_ROW *

row

)

returns TRUE iff row is removable from the LP (due to aging or cleanup)

Parameters

row

LP row

SCIP_ROWORIGINTYPE SCIProwGetOrigintype

(

SCIP_ROW *

row

)

returns type of origin that created the row

Parameters

row

LP row

SCIP_CONSHDLR* SCIProwGetOriginCons

(

SCIP_ROW *

row

)

returns origin constraint handler that created the row (NULL if not available)

Parameters

row

LP row

SCIP_SEPA* SCIProwGetOriginSepa

(

SCIP_ROW *

row

)

returns origin separator that created the row (NULL if not available)

Parameters

row

LP row

SCIP_Bool SCIProwIsInGlobalCutpool

(

SCIP_ROW *

row

)

returns TRUE iff row is member of the global cut pool

Parameters

row

LP row

int SCIProwGetLPPos

(

SCIP_ROW *

row

)

gets position of row in current LP, or -1 if it is not in LP

Parameters

row

LP row

int SCIProwGetLPDepth

(

SCIP_ROW *

row

)

gets depth in the tree where the row entered the LP, or -1 if it is not in LP

Parameters

row

LP row

SCIP_Bool SCIProwIsInLP

(

SCIP_ROW *

row

)

returns TRUE iff row is member of current LP

Parameters

row

LP row

void SCIProwChgRank	(	SCIP_ROW *	row,
		int	rank
	)

changes the rank of LP row

Parameters

row	LP row
rank	new value for rank