Scippy

SCIP

Solving Constraint Integer Programs

Nh Struct Reference

Detailed Description

neighborhood data structure with callbacks, statistics, fixing rate

Definition at line 334 of file heur_alns.c.

Public Member Functions

 DECL_VARFIXINGS ((*varfixings))
 
 DECL_CHANGESUBSCIP ((*changesubscip))
 
 DECL_NHINIT ((*nhinit))
 
 DECL_NHEXIT ((*nhexit))
 
 DECL_NHFREE ((*nhfree))
 
 DECL_NHREFSOL ((*nhrefsol))
 
 DECL_NHDEACTIVATE ((*nhdeactivate))
 

Data Fields

char * name
 
NH_FIXINGRATE fixingrate
 
NH_STATS stats
 
SCIP_Bool active
 
SCIP_Real priority
 
union {
   DATA_MUTATION *   mutation
 
   DATA_CROSSOVER *   crossover
 
   DATA_DINS *   dins
 
data
 

Member Function Documentation

◆ DECL_VARFIXINGS()

Nh::DECL_VARFIXINGS ( varfixings)

variable fixings callback for this neighborhood

◆ DECL_CHANGESUBSCIP()

Nh::DECL_CHANGESUBSCIP ( changesubscip)

callback for subproblem changes other than variable fixings

◆ DECL_NHINIT()

Nh::DECL_NHINIT ( nhinit)

initialization callback when a new problem is read

◆ DECL_NHEXIT()

Nh::DECL_NHEXIT ( nhexit)

deinitialization callback when exiting a problem

◆ DECL_NHFREE()

Nh::DECL_NHFREE ( nhfree)

deinitialization callback before SCIP is freed

◆ DECL_NHREFSOL()

Nh::DECL_NHREFSOL ( nhrefsol)

callback function to return a reference solution for further fixings, or NULL

◆ DECL_NHDEACTIVATE()

Nh::DECL_NHDEACTIVATE ( nhdeactivate)

callback function to deactivate neighborhoods on problems where they are irrelevant, or NULL if it is always active

Field Documentation

◆ name

char* Nh::name

the name of this neighborhood

Definition at line 336 of file heur_alns.c.

Referenced by alnsFreeNeighborhood(), printNeighborhoodStatistics(), and SCIP_DECL_HEUREXEC().

◆ fixingrate

NH_FIXINGRATE Nh::fixingrate

fixing rate for this neighborhood

Definition at line 337 of file heur_alns.c.

Referenced by DECL_VARFIXINGS(), neighborhoodFixVariables(), printNeighborhoodStatistics(), SCIP_DECL_HEURINIT(), and updateFixingRate().

◆ stats

NH_STATS Nh::stats

statistics for this neighborhood

Definition at line 338 of file heur_alns.c.

Referenced by alnsFreeNeighborhood(), printNeighborhoodStatistics(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEURINIT(), and updateNeighborhoodStats().

◆ active

SCIP_Bool Nh::active

is this neighborhood active or not?

Definition at line 346 of file heur_alns.c.

Referenced by SCIP_DECL_HEURINITSOL().

◆ priority

SCIP_Real Nh::priority

positive call priority to initialize bandit algorithms

Definition at line 347 of file heur_alns.c.

◆ mutation

DATA_MUTATION* Nh::mutation

mutation data

Definition at line 350 of file heur_alns.c.

Referenced by DECL_NHEXIT(), DECL_NHINIT(), and DECL_VARFIXINGS().

◆ crossover

DATA_CROSSOVER* Nh::crossover

crossover data

Definition at line 351 of file heur_alns.c.

Referenced by DECL_NHEXIT(), DECL_NHFREE(), DECL_NHINIT(), DECL_NHREFSOL(), DECL_VARFIXINGS(), and includeNeighborhoods().

◆ dins

DATA_DINS* Nh::dins

dins data

Definition at line 352 of file heur_alns.c.

Referenced by DECL_NHFREE(), DECL_VARFIXINGS(), and includeNeighborhoods().

◆ data

union { ... } Nh::data

data object for neighborhood specific data

Referenced by DECL_NHEXIT(), DECL_NHFREE(), DECL_NHINIT(), DECL_NHREFSOL(), DECL_VARFIXINGS(), and includeNeighborhoods().