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 import java.util.Iterator;
21
22 import org.apache.commons.math4.neuralnet.Network;
23
24 /**
25 * Trainer for Kohonen's Self-Organizing Map.
26 *
27 * @since 3.3
28 */
29 public class KohonenTrainingTask implements Runnable {
30 /** SOFM to be trained. */
31 private final Network net;
32 /** Training data. */
33 private final Iterator<double[]> featuresIterator;
34 /** Update procedure. */
35 private final KohonenUpdateAction updateAction;
36
37 /**
38 * Creates a (sequential) trainer for the given network.
39 *
40 * @param net Network to be trained with the SOFM algorithm.
41 * @param featuresIterator Training data iterator.
42 * @param updateAction SOFM update procedure.
43 */
44 public KohonenTrainingTask(Network net,
45 Iterator<double[]> featuresIterator,
46 KohonenUpdateAction updateAction) {
47 this.net = net;
48 this.featuresIterator = featuresIterator;
49 this.updateAction = updateAction;
50 }
51
52 /**
53 * {@inheritDoc}
54 */
55 @Override
56 public void run() {
57 while (featuresIterator.hasNext()) {
58 updateAction.update(net, featuresIterator.next());
59 }
60 }
61 }