Ant.java

/*
 * MIT License
 *
 * Copyright (c) 2009-2016 Enrique Areyan <enrique3 at gmail.com>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package libai.ants;

import java.util.ArrayList;
import java.util.List;


/**
 * This class belong to the core classes of the Ant Framework.
 * <p>
 * It represent an Ant. An Ant is composed of a current position, an index where
 * it belong in the Enviroment array an a current solution
 *
 * @author Enrique Areyan, enrique3 at gmail.com
 * @version 1
 */
public class Ant {

    /**
     * Current Ant solution
     */
    protected List<Integer> solution;
    /**
     * Current Ant position, i.e.: the index of a node in the problem graph
     */
    protected int currentPos;
    /**
     * This Ant's position in the Enviroment's Ants array
     */
    protected int index;

    /**
     * Constructor. Allocates the ant's index and initial position
     *
     * @param index ant's index in the enviroment array
     * @param initialPos ant's initial position (node index) in the problem
     * graph
     */
    protected Ant(int index, int initialPos) {
        this.index = index;
        this.currentPos = initialPos;
        this.solution = new ArrayList<>();
    }

    /**
     * Returns the ant's current position
     *
     * @return the ant's current position.
     */
    public int getCurrentPos() {
        return currentPos;
    }

    /**
     * Sets the ant's current position
     *
     * @param pos the ant's current position
     */
    protected void setCurrentPos(int pos) {
        this.currentPos = pos;
    }

    /**
     * Clears the ant's current solution
     */
    public void clearSolution() {
        this.solution.clear();
    }

    /**
     * Returns a reference to the Vector with the ant's current solution
     *
     * @return a reference to the Vector with the ant's current solution
     */
    public List<Integer> getSolution() {
        return solution;
    }

    /**
     * Sets a Vector to be the ant's current solution
     *
     * @param solution a Vector with a solution
     */
    public void setSolution(List<Integer> solution) {
        this.solution = solution;
    }

    /**
     * Returns a copy of the Vector with the ant's current solution
     *
     * @return a copy of the Vector with the ant's current solution
     */
    public List<Integer> copySolution() {
        return new ArrayList<>(this.solution);
    }

    /**
     * Ads a component to the ant's current Vector solution
     *
     * @param Solution an integer component to be added to the current ant's
     * solution
     */
    public void addSolution(int Solution) {
        this.solution.add(Solution);
    }

    /**
     * Returns the size of the ant's current solution
     *
     * @return an integer corresponding to the size of the ant's current
     * solution
     */
    public int getSolutionSize() {
        return this.solution.size();
    }

    /**
     * Prints the ant's current solution to the standard output
     */
    public void printSolution() {
        System.out.println("Solution of length: " + this.solution.size());
        System.out.println(this.solution.toString());
    }

    /**
     * Return the string representation of an ant. Useful for debugging.
     *
     * @return An string with the ant's index an current solution.
     */
    @Override
    public String toString() {
        return "{i = " + this.index + "," + this.solution.toString() + "}";
    }
}