pub_matrix.h File Reference

Detailed Description

public methods for MILP matrix

Author

Dieter Weninger

Definition in file pub_matrix.h.

#include "scip/def.h"
#include "scip/type_var.h"
#include "scip/type_cons.h"
#include "scip/type_matrix.h"

Go to the source code of this file.

Functions
SCIP_Real *	SCIPmatrixGetColValPtr (SCIPMILPMATRIX *matrix, int col)
int *	SCIPmatrixGetColIdxPtr (SCIPMILPMATRIX *matrix, int col)
int	SCIPmatrixGetColNNonzs (SCIPMILPMATRIX *matrix, int col)
int	SCIPmatrixGetNColumns (SCIPMILPMATRIX *matrix)
SCIP_Real	SCIPmatrixGetColUb (SCIPMILPMATRIX *matrix, int col)
SCIP_Real	SCIPmatrixGetColLb (SCIPMILPMATRIX *matrix, int col)
int	SCIPmatrixGetColNUplocks (SCIPMILPMATRIX *matrix, int col)
int	SCIPmatrixGetColNDownlocks (SCIPMILPMATRIX *matrix, int col)
SCIP_VAR *	SCIPmatrixGetVar (SCIPMILPMATRIX *matrix, int col)
const char *	SCIPmatrixGetColName (SCIPMILPMATRIX *matrix, int col)
SCIP_Real *	SCIPmatrixGetRowValPtr (SCIPMILPMATRIX *matrix, int row)
int *	SCIPmatrixGetRowIdxPtr (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetRowNNonzs (SCIPMILPMATRIX *matrix, int row)
const char *	SCIPmatrixGetRowName (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetNRows (SCIPMILPMATRIX *matrix)
SCIP_Real	SCIPmatrixGetRowLhs (SCIPMILPMATRIX *matrix, int row)
SCIP_Real	SCIPmatrixGetRowRhs (SCIPMILPMATRIX *matrix, int row)
SCIP_Bool	SCIPmatrixIsRowRhsInfinity (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetNNonzs (SCIPMILPMATRIX *matrix)
SCIP_Real	SCIPmatrixGetRowMinActivity (SCIPMILPMATRIX *matrix, int row)
SCIP_Real	SCIPmatrixGetRowMaxActivity (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetRowNMinActNegInf (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetRowNMinActPosInf (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetRowNMaxActNegInf (SCIPMILPMATRIX *matrix, int row)
int	SCIPmatrixGetRowNMaxActPosInf (SCIPMILPMATRIX *matrix, int row)
SCIP_CONS *	SCIPmatrixGetCons (SCIPMILPMATRIX *matrix, int row)
SCIP_Bool	SCIPmatrixUplockConflict (SCIPMILPMATRIX *matrix, int col)
SCIP_Bool	SCIPmatrixDownlockConflict (SCIPMILPMATRIX *matrix, int col)
SCIP_RETCODE	SCIPmatrixCreate (SCIP *scip, SCIPMILPMATRIX **matrixptr, SCIP_Bool *initialized, SCIP_Bool *complete)
void	SCIPmatrixFree (SCIP *scip, SCIPMILPMATRIX **matrix)
void	SCIPmatrixPrintRow (SCIP *scip, SCIPMILPMATRIX *matrix, int row)
SCIP_RETCODE	SCIPmatrixGetParallelRows (SCIP *scip, SCIPMILPMATRIX *matrix, SCIP_Real *scale, int *pclass)
SCIP_RETCODE	SCIPmatrixGetParallelCols (SCIP *scip, SCIPMILPMATRIX *matrix, SCIP_Real *scale, int *pclass, SCIP_Bool *varineq)

Function Documentation

SCIP_Real* SCIPmatrixGetColValPtr	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get column based start pointer of values

Parameters

matrix	matrix instance
col	column index

int* SCIPmatrixGetColIdxPtr	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get column based start pointer of row indices

Parameters

matrix	matrix instance
col	column index

int SCIPmatrixGetColNNonzs	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get the number of non-zero entries of this column

Parameters

matrix	matrix instance
col	column index

int SCIPmatrixGetNColumns

(

SCIPMILPMATRIX *

matrix

)

get number of columns of the matrix

Parameters

matrix

matrix instance

SCIP_Real SCIPmatrixGetColUb	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get upper bound of column

Parameters

matrix	matrix instance
col	column index

SCIP_Real SCIPmatrixGetColLb	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get lower bound of column

Parameters

matrix	matrix instance
col	column index

int SCIPmatrixGetColNUplocks	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get number of uplocks of column

Parameters

matrix	matrix instance
col	column index

int SCIPmatrixGetColNDownlocks	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get number of downlocks of column

Parameters

matrix	matrix instance
col	column index

SCIP_VAR* SCIPmatrixGetVar	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get variable pointer of column

Parameters

matrix	matrix instance
col	column index

const char* SCIPmatrixGetColName	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get name of column/variable

Parameters

matrix	matrix instance
col	column index

SCIP_Real* SCIPmatrixGetRowValPtr	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get row based start pointer of values

Parameters

matrix	matrix instance
row	row index

int* SCIPmatrixGetRowIdxPtr	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get row based start pointer of column indices

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetRowNNonzs	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get number of non-zeros of this row

Parameters

matrix	matrix instance
row	row index

const char* SCIPmatrixGetRowName	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get name of row

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetNRows

(

SCIPMILPMATRIX *

matrix

)

get number of rows of the matrix

Parameters

matrix

matrix instance

SCIP_Real SCIPmatrixGetRowLhs	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get left-hand-side of row

Parameters

matrix	matrix instace
row	row index

SCIP_Real SCIPmatrixGetRowRhs	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get right-hand-side of row

Parameters

matrix	matrix instance
row	row index

SCIP_Bool SCIPmatrixIsRowRhsInfinity	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

flag indicating if right-hand-side of row is infinity

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetNNonzs

(

SCIPMILPMATRIX *

matrix

)

get number of non-zeros of matrix

Parameters

matrix

matrix instance

SCIP_Real SCIPmatrixGetRowMinActivity	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get minimal activity of row

Parameters

matrix	matrix instance
row	row index

SCIP_Real SCIPmatrixGetRowMaxActivity	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get maximal activity of row

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetRowNMinActNegInf	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get number of negative infinities present within minimal activity

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetRowNMinActPosInf	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get number of positive infinities present within minimal activity

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetRowNMaxActNegInf	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get number of negative infinities present within maximal activity

Parameters

matrix	matrix instance
row	row index

int SCIPmatrixGetRowNMaxActPosInf	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get number of positive infinities present within maximal activity

Parameters

matrix	matrix instance
row	row index

SCIP_CONS* SCIPmatrixGetCons	(	SCIPMILPMATRIX *	matrix,
		int	row
	)

get constraint pointer for constraint representing row

Parameters

matrix	matrix instance
row	row index

SCIP_Bool SCIPmatrixUplockConflict	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get if conflicting uplocks of variable present

Parameters

matrix	matrix instance
col	column index

SCIP_Bool SCIPmatrixDownlockConflict	(	SCIPMILPMATRIX *	matrix,
		int	col
	)

get if conflicting downlocks of variable present

Parameters

matrix	matrix instance
col	column index

SCIP_RETCODE SCIPmatrixCreate	(	SCIP *	scip,
		SCIPMILPMATRIX **	matrixptr,
		SCIP_Bool *	initialized,
		SCIP_Bool *	complete
	)

initialize matrix

Parameters

scip	current scip instance
matrixptr	pointer to constraint matrix object to be initialized
initialized	was the initialization successful?
complete	are all constraint represented within the matrix?

void SCIPmatrixFree	(	SCIP *	scip,
		SCIPMILPMATRIX **	matrix
	)

frees the constraint matrix

Parameters

scip	current SCIP instance
matrix	constraint matrix object

void SCIPmatrixPrintRow	(	SCIP *	scip,
		SCIPMILPMATRIX *	matrix,
		int	row
	)

print one row of the MILP matrix

Parameters

scip	current SCIP instance
matrix	constraint matrix object
row	row index

SCIP_RETCODE SCIPmatrixGetParallelRows	(	SCIP *	scip,
		SCIPMILPMATRIX *	matrix,
		SCIP_Real *	scale,
		int *	pclass
	)

detect parallel rows, rhs/lhs are ignored

Parameters

scip	current SCIP instance
matrix	matrix containing the constraints
scale	scale factors of rows
pclass	parallel row classes

SCIP_RETCODE SCIPmatrixGetParallelCols	(	SCIP *	scip,
		SCIPMILPMATRIX *	matrix,
		SCIP_Real *	scale,
		int *	pclass,
		SCIP_Bool *	varineq
	)

detect parallel rows, obj ignored

Parameters

scip	current SCIP instance
matrix	matrix containing the constraints
scale	scale factors of cols
pclass	parallel column classes
varineq	indicating if variable is within an equation