Module org.jgrapht.core

Package org.jgrapht.alg.matching.blossom.v5

Class BlossomVOptions

java.lang.Object

org.jgrapht.alg.matching.blossom.v5.BlossomVOptions

public class BlossomVOptions
extends java.lang.Object

BlossomVOptions that define the strategies to use during the algorithm for updating duals and initializing the matching

According to the experimental results, the greedy initialization substantially speeds up the algorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlossomVOptions.DualUpdateStrategy	Enum for choosing dual updates strategy
static class	BlossomVOptions.InitializationType	Enum for types of matching initialization

Field Summary

Fields

Modifier and Type	Field	Description
static BlossomVOptions[]	ALL_OPTIONS	All possible options
private static BlossomVOptions.DualUpdateStrategy	DEFAULT_DUAL_UPDATE_TYPE	Default dual updates strategy
private static BlossomVOptions.InitializationType	DEFAULT_INITIALIZATION_TYPE	Default algorithm initialization type
private static boolean	DEFAULT_UPDATE_DUALS_AFTER	Default value for the flag updateDualsAfter
private static boolean	DEFAULT_UPDATE_DUALS_BEFORE	Default value for the flag updateDualsBefore
(package private) BlossomVOptions.DualUpdateStrategy	dualUpdateStrategy	What greedy strategy to use to perform a global dual update
(package private) BlossomVOptions.InitializationType	initializationType	What strategy to choose to initialize the matching before the main phase of the algorithm
(package private) boolean	updateDualsAfter	Whether to update duals of the tree after growth
(package private) boolean	updateDualsBefore	Whether to update duals of the tree before growth

Constructor Summary

Constructors

Constructor	Description
BlossomVOptions()	Constructs a default set of options for the algorithm
BlossomVOptions(BlossomVOptions.InitializationType initializationType)	Constructs a new options instance with a initializationType
BlossomVOptions(BlossomVOptions.InitializationType initializationType, BlossomVOptions.DualUpdateStrategy dualUpdateStrategy, boolean updateDualsBefore, boolean updateDualsAfter)	Constructs a custom set of options for the algorithm

Method Summary

Modifier and Type	Method	Description
BlossomVOptions.DualUpdateStrategy	getDualUpdateStrategy()	Returns dual updates strategy
BlossomVOptions.InitializationType	getInitializationType()	Returns initialization type
boolean	isUpdateDualsAfter()	Returns the updateDualsAfter flag
boolean	isUpdateDualsBefore()	Returns the updateDualsBefore flag
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL_OPTIONS

public static final BlossomVOptions[] ALL_OPTIONS

All possible options

DEFAULT_INITIALIZATION_TYPE

private static final BlossomVOptions.InitializationType DEFAULT_INITIALIZATION_TYPE

Default algorithm initialization type

DEFAULT_DUAL_UPDATE_TYPE

private static final BlossomVOptions.DualUpdateStrategy DEFAULT_DUAL_UPDATE_TYPE

Default dual updates strategy

DEFAULT_UPDATE_DUALS_BEFORE

private static final boolean DEFAULT_UPDATE_DUALS_BEFORE

Default value for the flag updateDualsBefore

See Also:

Constant Field Values

DEFAULT_UPDATE_DUALS_AFTER

private static final boolean DEFAULT_UPDATE_DUALS_AFTER

Default value for the flag updateDualsAfter

See Also:

Constant Field Values

dualUpdateStrategy

BlossomVOptions.DualUpdateStrategy dualUpdateStrategy

What greedy strategy to use to perform a global dual update

initializationType

BlossomVOptions.InitializationType initializationType

What strategy to choose to initialize the matching before the main phase of the algorithm

updateDualsBefore

boolean updateDualsBefore

Whether to update duals of the tree before growth

updateDualsAfter

boolean updateDualsAfter

Whether to update duals of the tree after growth

Constructor Detail

BlossomVOptions

public BlossomVOptions(BlossomVOptions.InitializationType initializationType,
                       BlossomVOptions.DualUpdateStrategy dualUpdateStrategy,
                       boolean updateDualsBefore,
                       boolean updateDualsAfter)

Constructs a custom set of options for the algorithm

Parameters:

dualUpdateStrategy - greedy strategy to update dual variables globally

initializationType - strategy for initializing the matching

updateDualsBefore - whether to update duals of the tree before growth

updateDualsAfter - whether to update duals of the tree after growth

BlossomVOptions

public BlossomVOptions(BlossomVOptions.InitializationType initializationType)

Constructs a new options instance with a initializationType

Parameters:

initializationType - defines a strategy to use to initialize the matching

BlossomVOptions

public BlossomVOptions()

Constructs a default set of options for the algorithm

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isUpdateDualsBefore

public boolean isUpdateDualsBefore()

Returns the updateDualsBefore flag

Returns:

the flag updateDualsBefore

isUpdateDualsAfter

public boolean isUpdateDualsAfter()

Returns the updateDualsAfter flag

Returns:

the flag updateDualsAfter

getDualUpdateStrategy

public BlossomVOptions.DualUpdateStrategy getDualUpdateStrategy()

Returns dual updates strategy

Returns:

dual updates strategy

getInitializationType

public BlossomVOptions.InitializationType getInitializationType()

Returns initialization type

Returns:

initialization type