Detailed Description

public methods for branching rules

Author: Tobias Achterberg

Definition in file pub_branch.h.

#include "scip/def.h"
#include "scip/type_misc.h"
#include "scip/type_branch.h"

Functions
	SCIP_DECL_SORTPTRCOMP (SCIPbranchruleComp)

	SCIP_DECL_SORTPTRCOMP (SCIPbranchruleCompName)

SCIP_BRANCHRULEDATA *	SCIPbranchruleGetData (SCIP_BRANCHRULE *branchrule)

void	SCIPbranchruleSetData (SCIP_BRANCHRULE branchrule, SCIP_BRANCHRULEDATA branchruledata)

const char *	SCIPbranchruleGetName (SCIP_BRANCHRULE *branchrule)

const char *	SCIPbranchruleGetDesc (SCIP_BRANCHRULE *branchrule)

int	SCIPbranchruleGetPriority (SCIP_BRANCHRULE *branchrule)

int	SCIPbranchruleGetMaxdepth (SCIP_BRANCHRULE *branchrule)

SCIP_Real	SCIPbranchruleGetMaxbounddist (SCIP_BRANCHRULE *branchrule)

SCIP_Real	SCIPbranchruleGetSetupTime (SCIP_BRANCHRULE *branchrule)

SCIP_Real	SCIPbranchruleGetTime (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNLPCalls (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNExternCalls (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNPseudoCalls (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNCutoffs (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNCutsFound (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNConssFound (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNDomredsFound (SCIP_BRANCHRULE *branchrule)

SCIP_Longint	SCIPbranchruleGetNChildren (SCIP_BRANCHRULE *branchrule)

SCIP_Bool	SCIPbranchruleIsInitialized (SCIP_BRANCHRULE *branchrule)

Function Documentation

SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleComp )

compares two branching rules w. r. to their priority

SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleCompName )

comparison method for sorting branching rules w.r.t. to their name

SCIP_BRANCHRULEDATA* SCIPbranchruleGetData ( SCIP_BRANCHRULE * branchrule )

gets user data of branching rule

Parameters

branchrule branching rule

void SCIPbranchruleSetData	(	SCIP_BRANCHRULE *	branchrule,
		SCIP_BRANCHRULEDATA *	branchruledata
	)

sets user data of branching rule; user has to free old data in advance!

Parameters

branchrule	branching rule
branchruledata	new branching rule user data

const char* SCIPbranchruleGetName ( SCIP_BRANCHRULE * branchrule )

gets name of branching rule

Parameters

branchrule branching rule

const char* SCIPbranchruleGetDesc ( SCIP_BRANCHRULE * branchrule )

gets description of branching rule

Parameters

branchrule branching rule

int SCIPbranchruleGetPriority ( SCIP_BRANCHRULE * branchrule )

gets priority of branching rule

Parameters

branchrule branching rule

int SCIPbranchruleGetMaxdepth ( SCIP_BRANCHRULE * branchrule )

gets maximal depth level, up to which this branching rule should be used (-1 for no limit)

Parameters

branchrule branching rule

SCIP_Real SCIPbranchruleGetMaxbounddist ( SCIP_BRANCHRULE * branchrule )

gets maximal relative distance from current node's dual bound to primal bound for applying branching rule

Parameters

branchrule branching rule

SCIP_Real SCIPbranchruleGetSetupTime ( SCIP_BRANCHRULE * branchrule )

gets time in seconds used in this branching rule for setting up for next stages

Parameters

branchrule branching rule

SCIP_Real SCIPbranchruleGetTime ( SCIP_BRANCHRULE * branchrule )

gets time in seconds used in this branching rule

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNLPCalls ( SCIP_BRANCHRULE * branchrule )

gets the total number of times, the branching rule was called on an LP solution

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNExternCalls ( SCIP_BRANCHRULE * branchrule )

gets the total number of times, the branching rule was called on external candidates

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNPseudoCalls ( SCIP_BRANCHRULE * branchrule )

gets the total number of times, the branching rule was called on a pseudo solution

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNCutoffs ( SCIP_BRANCHRULE * branchrule )

gets the total number of times, the branching rule detected a cutoff

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNCutsFound ( SCIP_BRANCHRULE * branchrule )

gets the total number of cuts, the branching rule separated

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNConssFound ( SCIP_BRANCHRULE * branchrule )

gets the total number of constraints, the branching rule added to the respective local nodes (not counting constraints that were added to the child nodes as branching decisions)

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNDomredsFound ( SCIP_BRANCHRULE * branchrule )

gets the total number of domain reductions, the branching rule found

Parameters

branchrule branching rule

SCIP_Longint SCIPbranchruleGetNChildren ( SCIP_BRANCHRULE * branchrule )

gets the total number of children, the branching rule created

Parameters

branchrule branching rule

SCIP_Bool SCIPbranchruleIsInitialized ( SCIP_BRANCHRULE * branchrule )

is branching rule initialized?

Parameters

branchrule branching rule

SCIP

Detailed Description

Functions

Function Documentation