StatProbe.java

/*
 * Class:        StatProbe
 * Description:  statistical probe
 * Environment:  Java
 * Software:     SSJ
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author
 * @since
 *
 *
 * Licensed 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 umontreal.ssj.stat;
 
import java.util.List;
import java.util.ArrayList;
import umontreal.ssj.util.PrintfFormat;

public abstract class StatProbe {
 
   private List<ObservationListener> listeners = new ArrayList<ObservationListener>();
   protected String name;
   protected double maxValue;
   protected double minValue;
   protected double sumValue;
   protected boolean collect = true;
   protected boolean broadcast = false;
   protected boolean showNobs = true;

   abstract public void init();

   public void setName(String name) {
      this.name = name;
   }

   public String getName() {
      return name;
   }

   public double min() {
      return minValue;
   }

   public double max() {
      return maxValue;
   }

   public double sum() {
      return sumValue;
   }

   abstract public double average();

   abstract public String report();

   abstract public String shortReport();

   abstract public String shortReportHeader();

   public static String report(String globalName, StatProbe[] probes) {
      int maxn = 0;
      StatProbe firstProbe = null;
      for (StatProbe probe : probes) {
         if (firstProbe == null)
            firstProbe = probe;
         String s = probe.getName();
         if (s != null && s.length() > maxn)
            maxn = s.length();
      }
      if (firstProbe == null)
         return "";
      StringBuffer sb = new StringBuffer("Report for ");
      sb.append(globalName).append(PrintfFormat.NEWLINE);
      for (int i = 0; i < maxn; i++)
         sb.append(' ');
      sb.append("   ");
      sb.append(firstProbe.shortReportHeader()).append(PrintfFormat.NEWLINE);
      for (StatProbe probe : probes) {
         sb.append(PrintfFormat.s(-maxn, probe.getName()));
         sb.append("   ");
         sb.append(probe.shortReport()).append(PrintfFormat.NEWLINE);
      }
      return sb.toString();
   }

   public static String report(String globalName, Iterable<? extends StatProbe> probes) {
      int maxn = 0;
      StatProbe firstProbe = null;
      for (StatProbe probe : probes) {
         if (firstProbe == null)
            firstProbe = probe;
         String s = probe.getName();
         int sl = s == null ? 4 : s.length();
         if (sl > maxn)
            maxn = sl;
      }
      if (firstProbe == null)
         return "";
      StringBuffer sb = new StringBuffer("Report for ");
      sb.append(globalName).append(PrintfFormat.NEWLINE);
      for (int i = 0; i < maxn; i++)
         sb.append(' ');
      sb.append("   ");
      sb.append(firstProbe.shortReportHeader()).append(PrintfFormat.NEWLINE);
      for (StatProbe probe : probes) {
         sb.append(PrintfFormat.s(-maxn, probe.getName()));
         sb.append("   ");
         sb.append(probe.shortReport()).append(PrintfFormat.NEWLINE);
      }
      return sb.toString();
   }

   public boolean isBroadcasting() {
      return broadcast;
   }

   public void setBroadcasting(boolean b) {
      broadcast = b;
   }

   public boolean isCollecting() {
      return collect;
   }

   public void setCollecting(boolean b) {
      collect = b;
   }

   public void addObservationListener(ObservationListener l) {
      if (l == null)
         throw new NullPointerException();
      if (!listeners.contains(l))
         listeners.add(l);
   }

   public void removeObservationListener(ObservationListener l) {
      listeners.remove(l);
   }

   public void clearObservationListeners() {
      listeners.clear();
   }

   public void notifyListeners(double x) {
      if (!broadcast)
         return;
      // We could also use the enhanced for loop here, but this is less efficient.
      final int nl = listeners.size();
      for (int i = 0; i < nl; i++)
         listeners.get(i).newObservation(this, x);
   }
 
   public StatProbe clone() throws CloneNotSupportedException {
      StatProbe s = (StatProbe) super.clone();
      s.listeners = new ArrayList<ObservationListener>(listeners);
      return s;
   }
}