1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.math4.neuralnet.sofm;
19
20 /**
21 * Provides the network neighbourhood's size as a function of the
22 * number of calls already performed during the learning task.
23 * The "neighbourhood" is the set of neurons that can be reached
24 * by traversing at most the number of links returned by this
25 * function.
26 *
27 * @since 3.3
28 */
29 public interface NeighbourhoodSizeFunction {
30 /**
31 * Computes the neighbourhood size at the current call.
32 *
33 * @param numCall Current step of the training task.
34 * @return the value of the function at {@code numCall}.
35 */
36 int value(long numCall);
37 }