net.sourceforge.cilib.coevolution.cooperative.problem.DimensionAllocation 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.coevolution.cooperative.problem;

import net.sourceforge.cilib.algorithm.population.PopulationBasedAlgorithm;
import net.sourceforge.cilib.coevolution.cooperative.CooperativeCoevolutionAlgorithm;
import net.sourceforge.cilib.measurement.single.Fitness;
import net.sourceforge.cilib.util.Cloneable;

/**
 * This abstract class hides the details of which sub-dimensions a participating
 * algorithm in a {@linkplain CooperativeCoevolutionAlgorithm} optimizes.
 * 
 * The {@linkplain CooperativeCoevolutionProblemAdapter} class uses the concrete
 * {@linkplain DimensionAllocation} to copy the solution from a participating
 * {@linkplain Entity} in a participating {@linkplain PopulationBasedAlgorithm}
 * into the context vector so that its {@linkplain Fitness} can be calculated.
 */
public abstract class DimensionAllocation implements Cloneable {
    private int size;

    /**
     * Constructor
     */
    public DimensionAllocation(){
        size = 0;
    }

    /**
     * Constructor
     * @param size The number of dimensions stored by this {@linkplain DimensionAllocation}.
     */
    public DimensionAllocation(int size){
        this.size = size;
    }

    /**
     * Copy constructor.
     * @param copy
     */
    public DimensionAllocation(DimensionAllocation copy){
        size = copy.size;
    }

    /**
     * Return the number of dimensions stored by this {@linkplain DimensionAllocation}.
     * @return
     */
    public int getSize() {
        return size;
    }

    /**
     * Return the index into the original problem vector of the element at the given index into the participant's solution.
     * @param elementIndex The index into the participant's solution vector.
     * @return The index of the same value for the original problem vector.
     */
    public abstract int getProblemIndex(int elementIndex);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract DimensionAllocation getClone();
}