SSPSolution.java

package com.aim.project.ssp.solution;

import com.aim.project.ssp.interfaces.SSPSolutionInterface;
import com.aim.project.ssp.interfaces.SolutionRepresentationInterface;

/**
 * Represents a solution to the SSP, including the solution's representation
 * and its associated objective function value. This class implements the SSPSolutionInterface.
 *
 * @author Sushant Nepal
 * @since 17/03/2025
 */
public class SSPSolution implements SSPSolutionInterface {

	private final SolutionRepresentationInterface oRepresentation; // The solution representation
	private double iObjectiveFunctionValue; // The value of the objective function

	/**
	 * Constructs a SSPSolution with the given solution representation and objective function value.
	 *
	 * @param oRepresentation The solution representation (tour) of locations.
	 * @param iObjectiveFunctionValue The objective function value for the solution.
	 */
	public SSPSolution(SolutionRepresentationInterface oRepresentation, double iObjectiveFunctionValue) {
		this.oRepresentation = oRepresentation;
		this.iObjectiveFunctionValue = iObjectiveFunctionValue;
	}

	/**
	 * Retrieves the objective function value of the solution.
	 *
	 * @return The objective function value.
	 */
	@Override
	public double getObjectiveFunctionValue() {
		return iObjectiveFunctionValue;
	}

	/**
	 * Sets the objective function value for the solution.
	 *
	 * @param objectiveFunctionValue The new objective function value.
	 */
	@Override
	public void setObjectiveFunctionValue(double objectiveFunctionValue) {
		this.iObjectiveFunctionValue = objectiveFunctionValue;
	}

	/**
	 * Retrieves the solution's representation, which stores the sequence of locations.
	 *
	 * @return The solution representation.
	 */
	@Override
	public SolutionRepresentationInterface getSolutionRepresentation() {
		return this.oRepresentation;
	}

	/**
	 * Creates a deep copy of the current solution, including the solution representation and objective function value.
	 *
	 * @return A new SSPSolution instance, which is a clone of the current solution.
	 */
	@Override
	public SSPSolutionInterface clone() {
		// Ensure deep cloning of the entire solution
		return new SSPSolution(this.oRepresentation.clone(), this.iObjectiveFunctionValue);
	}

	/**
	 * Returns the total number of locations in the solution, including the hotel and airport.
	 *
	 * @return The total number of locations in the solution representation.
	 */
	@Override
	public int getNumberOfLocations() {
		// Delegate to the representation class to get the number of locations
		return oRepresentation.getNumberOfLocations();
	}
}