Package com.dna.jopt.member.bucket.entity.controller.invokedoperator

Class EntityInvokedOperatorController

java.lang.Object

com.dna.jopt.member.bucket.entity.controller.invokedoperator.EntityInvokedOperatorController

All Implemented Interfaces:

IEntityInvokedOperatorController, Serializable

public class EntityInvokedOperatorController
extends Object
implements IEntityInvokedOperatorController

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EntityInvokedOperatorController()

Method Summary

Modifier and Type	Method	Description
IEntityInvokedOperatorController	copy()	Copies the IEntityInvokedOperatorController.
int	getBenefitCounter()	Gets the counter how many times no lower costs have been achieved by using an IOperator.
double	getCostAdvantage()	Gets the cost that was be saved by using the last beneficial Operator.
double	getLastBeneficialCostAdvantage()	Gets the amount of cost that was saved by using the last beneficial Operator.
Optional<com.dna.jopt.revision.operator.IOperator>	getLastBeneficialInvokedOperator()	Gets the last IOperator which realized a cost advantage.
Optional<com.dna.jopt.revision.operator.IOperator>	getLastInvokedOperator()	Gets the last invoked IOperator.
void	setCostAfterInvocation(double costAfterInvocation)	Updates the last invoked Operator and the last joined cost if said Operator proved to be beneficial for the cost.
void	setLastBeneficialJoinedCost(double lastBeneficialJoinedCost)
void	setLastBeneficialJoinedCostAfterInvocation(double lastBeneficialJoinedCostAfterInvocation)
void	setLastInvokedOperator(com.dna.jopt.revision.operator.IOperator op)	Sets the last invoked IOperator.
void	setLastJoinedCost(double lastJoinedCost)	Sets the cost before the new IOperator was invoked.

Methods inherited from class java.lang.Object

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

Constructor Details

EntityInvokedOperatorController

public EntityInvokedOperatorController()

Method Details

getLastInvokedOperator

public Optional<com.dna.jopt.revision.operator.IOperator> getLastInvokedOperator()

Description copied from interface: IEntityInvokedOperatorController

Gets the last invoked IOperator.

Specified by:

getLastInvokedOperator in interface IEntityInvokedOperatorController

Returns:

the Operator

getLastBeneficialInvokedOperator

public Optional<com.dna.jopt.revision.operator.IOperator> getLastBeneficialInvokedOperator()

Description copied from interface: IEntityInvokedOperatorController

Gets the last IOperator which realized a cost advantage.

If no such Operator was used, returns an empty Optional.

Specified by:

getLastBeneficialInvokedOperator in interface IEntityInvokedOperatorController

Returns:

the last beneficial Operator

setLastInvokedOperator

public void setLastInvokedOperator(com.dna.jopt.revision.operator.IOperator op)

Description copied from interface: IEntityInvokedOperatorController

Sets the last invoked IOperator.

Specified by:

setLastInvokedOperator in interface IEntityInvokedOperatorController

Parameters:

op - the iOperator last used

setLastJoinedCost

public void setLastJoinedCost(double lastJoinedCost)

Description copied from interface: IEntityInvokedOperatorController

Sets the cost before the new IOperator was invoked.

Specified by:

setLastJoinedCost in interface IEntityInvokedOperatorController

Parameters:

lastJoinedCost - the double cost before the Operator

setLastBeneficialJoinedCost

public void setLastBeneficialJoinedCost(double lastBeneficialJoinedCost)

setLastBeneficialJoinedCostAfterInvocation

public void setLastBeneficialJoinedCostAfterInvocation(double lastBeneficialJoinedCostAfterInvocation)

setCostAfterInvocation

public void setCostAfterInvocation(double costAfterInvocation)

Description copied from interface: IEntityInvokedOperatorController

Updates the last invoked Operator and the last joined cost if said Operator proved to be beneficial for the cost.

Specified by:

setCostAfterInvocation in interface IEntityInvokedOperatorController

Parameters:

costAfterInvocation - the double new cost after the Operator

getBenefitCounter

public int getBenefitCounter()

Description copied from interface: IEntityInvokedOperatorController

Gets the counter how many times no lower costs have been achieved by using an IOperator.

This counter resets when a beneficial Operator has been invoked and IEntityInvokedOperatorController.setCostAfterInvocation(double) has been called.

Specified by:

getBenefitCounter in interface IEntityInvokedOperatorController

Returns:

the number of times no benefit has been achieved

getCostAdvantage

public double getCostAdvantage()

Description copied from interface: IEntityInvokedOperatorController

Gets the cost that was be saved by using the last beneficial Operator.

Specified by:

getCostAdvantage in interface IEntityInvokedOperatorController

Returns:

the cost advantage of using said Operator

getLastBeneficialCostAdvantage

public double getLastBeneficialCostAdvantage()

Description copied from interface: IEntityInvokedOperatorController

Gets the amount of cost that was saved by using the last beneficial Operator.

Specified by:

getLastBeneficialCostAdvantage in interface IEntityInvokedOperatorController

Returns:

the saved cost

copy

public IEntityInvokedOperatorController copy()

Description copied from interface: IEntityInvokedOperatorController

Copies the IEntityInvokedOperatorController.

This is used when copying an IEntity since the history of the cost in the OperatorController is needed.

Specified by:

copy in interface IEntityInvokedOperatorController

Returns:

a copy of this Object