it.unibo.alchemist.model.linkingrules.ConnectWithinDistance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-implementationbase Show documentation

Abstract, incarnation independent implementations of the Alchemist's interfaces. Provides support for those who want to write incarnations.

There is a newer version: 35.0.1

Show newest version

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */
package it.unibo.alchemist.model.linkingrules;

import it.unibo.alchemist.model.neighborhoods.Neighborhoods;
import it.unibo.alchemist.model.Environment;
import it.unibo.alchemist.model.Neighborhood;
import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Position;

/**
 * LinkingRule which connects nodes whose euclidean distance is shorter than a
 * given radius.
 * 
 * @param 
 *            The type which describes the concentration of a molecule
 * @param 
 */
public class ConnectWithinDistance> extends AbstractLocallyConsistentLinkingRule {

    private static final long serialVersionUID = -405055780667941773L;
    private final double range;

    /**
     * @param radius
     *            connection radius
     */
    public ConnectWithinDistance(final double radius) {
        range = radius;
    }

    /**
     * Subclasses may change the way a neighborhood is computed.
     */
    @Override
    public Neighborhood computeNeighborhood(final Node center, final Environment environment) {
        return Neighborhoods.make(environment, center, environment.getNodesWithinRange(center, range));
    }

    /**
     * @return the range
     */
    protected final double getRange() {
        return range;
    }

}