de.sciss.neuralgas.EdgeGNG Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neuralgas-core Show documentation
Neural network simulator based on growing neural gas (GNG) - algorithms
The newest version!
// ========================================================================== ;
//                                                                            ;
// Copyright 1996-1998 Hartmut S. Loos, Instit. f. Neuroinformatik, Bochum    ;
// Copyright 2012-2013 Bernd Fritzke                                          ;
//                                                                            ;
// This program is free software; you can redistribute it and/or modify       ;
// it under the terms of the GNU General Public License as published by       ;
// the Free Software Foundation; either version 1, or (at your option)        ;
// any later version.                                                         ;
//                                                                            ;
// This program is distributed in the hope that it will be useful,            ;
// but WITHOUT ANY WARRANTY; without even the implied warranty of             ;
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              ;
// GNU General Public License for more details.                               ;
//                                                                            ;
// You should have received a copy of the GNU General Public License          ;
// along with this program; if not, write to the Free Software                ;
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                  ;
//                                                                            ;
// ========================================================================== ;

package de.sciss.neuralgas;

/**
 * A class representing an edge. 
 *  For example:
 *  *    EdgeGNG e = new EdgeGNG();
 *    e.from(Node1);
 *    e.to(Node2);
 * 
 */
public class EdgeGNG {
    /**
     * The starting point of the edge
     *
     * @see EdgeGNG
     */
    public int from = -1;

    /**
     * The end point of the edge
     *
     * @see EdgeGNG
     */
    public int to = -1;

    /**
     * The age of this edge.
     *
     * @see EdgeGNG
     */
    public int age = 0;

    /**
     * Replace a node with a new one. This is necessary after deleting a node
     * in the static array. In most cases the deleted node will be replaced by
     * the last node in the static array.
     *
     * @param old  The index of a node
     * @param newN The index of a node
     * @see ComputeGNG#deleteNode
     */
    protected void replace(int old, int newN) {
        if (from == old)
            from = newN;
        if (to == old)
            to = newN;
    }
}