net.sourceforge.cilib.measurement.single.NNWeightCount 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

The newest version!

/**           __  __
 *    _____ _/ /_/ /_    Computational Intelligence Library (CIlib)
 *   / ___/ / / / __ \   (c) CIRG @ UP
 *  / /__/ / / / /_/ /   http://cilib.net
 *  \___/_/_/_/_.___/
 */
package net.sourceforge.cilib.measurement.single;

import net.sourceforge.cilib.algorithm.Algorithm;
import net.sourceforge.cilib.measurement.Measurement;
import net.sourceforge.cilib.nn.architecture.Layer;
import net.sourceforge.cilib.nn.components.Neuron;
import net.sourceforge.cilib.problem.nn.NNTrainingProblem;
import net.sourceforge.cilib.type.types.Int;

/**
 * Counts the number of weights in a neural network.
 */
public class NNWeightCount implements Measurement {

    private int penalty;

    public NNWeightCount() {
        penalty = 0;
    }

    public NNWeightCount(NNWeightCount rhs) {
        penalty = rhs.penalty;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public NNWeightCount getClone() {
        return new NNWeightCount(this);
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Int getValue(Algorithm algorithm) {
        NNTrainingProblem problem = (NNTrainingProblem) algorithm.getOptimisationProblem();

        int count = 0;
        for (Layer curLayer : problem.getNeuralNetwork().getArchitecture().getLayers()) {
            for (Neuron curNeuron : curLayer) {
                count += curNeuron.getNumWeights();

                if (curNeuron.getActivationFunction() != null)
                    count += penalty;
            }
        }

        return Int.valueOf(count);
    }

    /**
     * Sets a penalty that should be added for each activation function in the NN.
     * @param newPenalty An integer estimate of how many weight evaluations
     *                      a activation function is worth.
     */
    public void setPenalty(int newPenalty) {
        penalty = newPenalty;
    }
}