SquareNeighbourhood.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.math4.neuralnet;

/**
 * Defines neighbourhood types.
 *
 * @since 3.3
 */
public enum SquareNeighbourhood {
    /**
     * <a href="http://en.wikipedia.org/wiki/Von_Neumann_neighborhood">
     *  Von Neumann neighbourhood</a>: in two dimensions, each (internal)
     * neuron has four neighbours.
     */
    VON_NEUMANN,
    /**
     * <a href="http://en.wikipedia.org/wiki/Moore_neighborhood">
     *  Moore neighbourhood</a>: in two dimensions, each (internal)
     * neuron has eight neighbours.
     */
    MOORE,
}