Package org.optaplanner.core.impl.heuristic.selector.common.nearby

Class AbstractNearbyDistanceMatrixDemand<Origin_,Destination_,ChildSelector_,ReplayingSelector_>

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.common.nearby.AbstractNearbyDistanceMatrixDemand<Origin_,Destination_,ChildSelector_,ReplayingSelector_>

Type Parameters:

Origin_ - planning entities

Destination_ - planning entities XOR planning values

ChildSelector_ -

ReplayingSelector_ -

All Implemented Interfaces:

Demand<NearbyDistanceMatrix<Origin_,Destination_>>

public abstract class AbstractNearbyDistanceMatrixDemand<Origin_,Destination_,ChildSelector_,ReplayingSelector_>
extends Object
implements Demand<NearbyDistanceMatrix<Origin_,Destination_>>

Calculating NearbyDistanceMatrix is very expensive, therefore we want to reuse it as much as possible.

In cases where the demand represents the same nearby selector (as defined by equals(Object)) the SupplyManager ensures that the same supply instance is returned with the pre-computed NearbyDistanceMatrix.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChildSelector_	childSelector
protected final NearbyDistanceMeter<Origin_,Destination_>	meter
protected final NearbyRandom	random
protected final ReplayingSelector_	replayingSelector

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNearbyDistanceMatrixDemand(NearbyDistanceMeter<Origin_,Destination_> meter, NearbyRandom random, ChildSelector_ childSelector, ReplayingSelector_ replayingSelector)

Method Summary

Modifier and Type	Method	Description
final NearbyDistanceMatrix<Origin_,Destination_>	createExternalizedSupply(SupplyManager supplyManager)	Only called if the domain model doesn't already support the demand (through a shadow variable usually).
final boolean	equals(Object o)	Two instances of this class are considered equal if and only if: Their meter instances are equal. Their nearby randoms represent the same distribution. Their child selectors are equal. Their replaying origin entity selectors are equal. Otherwise as defined by Object.equals(Object).
final int	hashCode()
protected abstract NearbyDistanceMatrix<Origin_,Destination_>	supplyNearbyDistanceMatrix()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

meter

protected final NearbyDistanceMeter<Origin_,Destination_> meter

random

protected final NearbyRandom random

childSelector

protected final ChildSelector_ childSelector

replayingSelector

protected final ReplayingSelector_ replayingSelector

Constructor Details

AbstractNearbyDistanceMatrixDemand

protected AbstractNearbyDistanceMatrixDemand(NearbyDistanceMeter<Origin_,Destination_> meter,
 NearbyRandom random,
 ChildSelector_ childSelector,
 ReplayingSelector_ replayingSelector)

Method Details

createExternalizedSupply

public final NearbyDistanceMatrix<Origin_,Destination_> createExternalizedSupply(SupplyManager supplyManager)

Description copied from interface: Demand

Only called if the domain model doesn't already support the demand (through a shadow variable usually). Equal demands share the same Supply.

Specified by:

createExternalizedSupply in interface Demand<Origin_>

Parameters:

supplyManager - never null

Returns:

never null

supplyNearbyDistanceMatrix

protected abstract NearbyDistanceMatrix<Origin_,Destination_> supplyNearbyDistanceMatrix()

equals

public final boolean equals(Object o)

Two instances of this class are considered equal if and only if:

• Their meter instances are equal.
• Their nearby randoms represent the same distribution.
• Their child selectors are equal.
• Their replaying origin entity selectors are equal.

Otherwise as defined by Object.equals(Object).

Overrides:

equals in class Object

See Also:

• for how we ensure equality for meter instances in particular and selectors in general.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object