KohonenTrainingTask.java

  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. package org.apache.commons.math4.neuralnet.sofm;

  18. import java.util.Iterator;

  19. import org.apache.commons.math4.neuralnet.Network;

  20. /**
  21.  * Trainer for Kohonen's Self-Organizing Map.
  22.  *
  23.  * @since 3.3
  24.  */
  25. public class KohonenTrainingTask implements Runnable {
  26.     /** SOFM to be trained. */
  27.     private final Network net;
  28.     /** Training data. */
  29.     private final Iterator<double[]> featuresIterator;
  30.     /** Update procedure. */
  31.     private final KohonenUpdateAction updateAction;

  32.     /**
  33.      * Creates a (sequential) trainer for the given network.
  34.      *
  35.      * @param net Network to be trained with the SOFM algorithm.
  36.      * @param featuresIterator Training data iterator.
  37.      * @param updateAction SOFM update procedure.
  38.      */
  39.     public KohonenTrainingTask(Network net,
  40.                                Iterator<double[]> featuresIterator,
  41.                                KohonenUpdateAction updateAction) {
  42.         this.net = net;
  43.         this.featuresIterator = featuresIterator;
  44.         this.updateAction = updateAction;
  45.     }

  46.     /**
  47.      * {@inheritDoc}
  48.      */
  49.     @Override
  50.     public void run() {
  51.         while (featuresIterator.hasNext()) {
  52.             updateAction.update(net, featuresIterator.next());
  53.         }
  54.     }
  55. }