SolutionRepresentation.java

package com.aim.project.ssp.solution;

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

/**
 * Represents a solution to the SSP, storing the sequence of locations in a tour.
 * This class implements the SolutionRepresentationInterface and provides methods for getting,
 * setting, and cloning the solution representation.
 *
 * @author Sushant Nepal
 * @since 17/03/2025
 */
public class SolutionRepresentation implements SolutionRepresentationInterface {

	private int[] aiSolutionRepresentation;

	/**
	 * Constructs a SolutionRepresentation with the given solution representation.
	 *
	 * @param aiRepresentation An array representing the solution (tour) in terms of location indices.
	 */
	public SolutionRepresentation(int[] aiRepresentation) {
		this.aiSolutionRepresentation = aiRepresentation;
	}

	/**
	 * Retrieves the solution representation, which is an array of location indices.
	 *
	 * @return The solution representation.
	 */
	@Override
	public int[] getSolutionRepresentation() {
		return aiSolutionRepresentation;
	}

	/**
	 * Sets the solution representation to a new array of location indices.
	 *
	 * @param aiSolutionRepresentation The new solution representation.
	 */
	@Override
	public void setSolutionRepresentation(int[] aiSolutionRepresentation) {
		this.aiSolutionRepresentation = aiSolutionRepresentation;
	}

	/**
	 * Returns the total number of locations in the solution representation, including the hotel and airport.
	 *
	 * @return The total number of locations in the representation.
	 */
	@Override
	public int getNumberOfLocations() {
		// Return the number of locations in the solution representation, including the hotel and airport
		return aiSolutionRepresentation.length + 2;
	}

	/**
	 * Creates a deep copy of the current SolutionRepresentation.
	 *
	 * @return A new SolutionRepresentation instance, which is a clone of the current solution.
	 */
	@Override
	public SolutionRepresentationInterface clone() {
		// Create and return a deep copy of the solution representation
		return new SolutionRepresentation(this.aiSolutionRepresentation.clone());
	}
}