net.sourceforge.cilib.controlparameter.UpdateOnIterationControlParameter 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.controlparameter;

import net.sourceforge.cilib.algorithm.*;

/**
 * A Control parameter that updates itself at the end of each iteration.
 */
public class UpdateOnIterationControlParameter implements ControlParameter, AlgorithmListener {
    
    private double parameter;
    private ControlParameter delegate;
    private boolean attached;
    
    public UpdateOnIterationControlParameter() {
        this(ConstantControlParameter.of(0.0));
    }

    public UpdateOnIterationControlParameter(ControlParameter delegate) {
        this.parameter = 0.0;
        this.delegate = delegate;
        this.attached = false;
    }
    
    public UpdateOnIterationControlParameter(UpdateOnIterationControlParameter copy) {
        this.parameter = copy.parameter;
        this.delegate = copy.delegate.getClone();
        this.attached = false;
    }
    
    @Override
    public UpdateOnIterationControlParameter getClone() {
        return new UpdateOnIterationControlParameter(this);
    }

    @Override
    public double getParameter() {
        if (!attached) {
            parameter = delegate.getParameter();
            AbstractAlgorithm.get().removeAlgorithmListener(this); // To prevent it being added multiple times
            AbstractAlgorithm.get().addAlgorithmListener(this);
            attached = true;
        }
        
        return parameter;
    }

    @Override
    public double getParameter(double min, double max) {
        throw new UnsupportedOperationException("Not supported yet.");
    }

    public void setDelegate(ControlParameter delegate) {
        this.delegate = delegate;
    }

    public ControlParameter getDelegate() {
        return delegate;
    }
    
    public void setParameter(double newParameter) {
        parameter = newParameter;
    }
    
    @Override
    public void algorithmStarted(AlgorithmEvent e) {
        parameter = delegate.getParameter();
    }

    @Override
    public void algorithmFinished(AlgorithmEvent e) {
        attached = false;
    }

    @Override
    public void iterationCompleted(AlgorithmEvent e) {
        parameter = delegate.getParameter();
    }
}