net.sourceforge.cilib.entity.visitor.TopologyVisitor 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.entity.visitor;

import net.sourceforge.cilib.util.Visitor;
import net.sourceforge.cilib.entity.Entity;
import net.sourceforge.cilib.entity.Topology;

/**
 * Interface for all visitor instances that visit an entire {@link Topology}
 * at once. These type of visitors are generally assocaited with the
 * calculation of topology related information, such as diameter and
 * radius calculations of the provided topologies.
 *
 */
public interface TopologyVisitor extends Visitor> {
    /**
     * Perfrom the visit operation on the provided {@link Topology}.
     * @param topology The {@link Topology} to visit.
     */
    @Override
    public void visit(Topology topology);

    /**
     * Get the result of the visitor after it has performed the visit()
     * action.
     * @return The result of the visit()
     */
    public Object getResult();
}