net.sourceforge.cilib.moo.archive.Archive Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cilib-library Show documentation
A library of composable components enabling simpler Computational Intelligence
There is a newer version: 0.8
/**           __  __
 *    _____ _/ /_/ /_    Computational Intelligence Library (CIlib)
 *   / ___/ / / / __ \   (c) CIRG @ UP
 *  / /__/ / / / /_/ /   http://cilib.net
 *  \___/_/_/_/_.___/
 */
package net.sourceforge.cilib.moo.archive;

import java.util.Collection;
import net.sourceforge.cilib.moo.archive.constrained.SetBasedConstrainedArchive;
import net.sourceforge.cilib.problem.solution.OptimisationSolution;

/**
 * 
 * A representation of an archive of non-dominated solutions used by Multi-objective optimisation
 * algorithms for solution storage during a search.
 * 
 *
 */
public interface Archive extends Collection {

    public static class Provider {

        private static ThreadLocal currentArchive = new ThreadLocal() {

            @Override
            protected Archive initialValue() {
                return new SetBasedConstrainedArchive();
            }
        };

        private Provider() {
        }

        /**
         * Static entrypoint to get to the Archive. This method is useful especially
         * in situations where you need to get to the archive from different locations
         * such as a {@code GuideSelectionStrategy}, or the {@link ArchivingIterationStep}
         * at the end of a multi-objective algorithm.
         * @return The currently active archive for a multi-objective algorithm.
         */
        public static Archive get() {
            return currentArchive.get();
        }

        /***
         * Set the archive to be used by a multi-objective optimisation algorithm.
         * @param archive A concrete archive implementation to be used as the active archive.
         */
        public static void set(Archive archive) {
            currentArchive.set(archive);
        }

        public static void remove() {
            currentArchive.remove();
        }
    }

    /**
     * Checks the entire archive and determines whether a solution exists that dominates {@code candidateSolution}.
     * @param candidateSolution The solution to compare against all of the solutions in the archive.
     * @return True if a solution exists that dominates {@code candidateSolution}, false otherwise.
     */
    public abstract boolean dominates(OptimisationSolution candidateSolution);

    /**
     * Checks the entire archive and determines whether a solution exists that is dominated by {@code candidateSolution}.
     * @param candidateSolution The solution to compare against all of the solutions in the archive.
     * @return True if a solution exists that is dominated by {@code candidateSolution}, false otherwise.
     */
    public abstract boolean isDominatedBy(OptimisationSolution candidateSolution);

    /**
     * Checks the entire archive and accumulates the solutions that dominates {@code candidateSolution}.
     * @param candidateSolution The solution to compare against all of the solutions in the archive.
     * @return The collection of solutions that dominates {@code candidateSolution}.
     */
    public abstract Collection getDominant(OptimisationSolution candidateSolution);

    /**
     * Checks the archive and accumulates all solutions that is dominated by {@code candidateSolution}.
     * @param candidateSolution The solution to compare against all of the solutions in the archive.
     * @return The collection of solutions dominated by the {@code candidateSolution}.
     */
    public abstract Collection getDominated(OptimisationSolution candidateSolution);
}