Class MeanVarianceArrayFunction

java.lang.Object
microsim.statistics.functions.AbstractFunction
microsim.statistics.functions.AbstractArrayFunction
microsim.statistics.functions.MeanVarianceArrayFunction
All Implemented Interfaces:
EventListener, IDoubleSource, IUpdatableSource
@Deprecated(forRemoval=true) public class MeanVarianceArrayFunction extends AbstractArrayFunction implements IDoubleSource
Deprecated, for removal: This API element is subject to removal in a future version.
use Stats
This class computes the average and variance value of an array of values taken from a data source. The mean function return always double values, so it implements only the IDoubleSource interface.
In order to retrieve the mean pass the MeanVarianceFunction.MEAN argument to the getDoubleValue function, while for the variance the MeanVarianceFunction.VARIANCE one.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Author:
Michele Sonnessa

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    MeanVarianceArrayFunction.Variables
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected double
    mean
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected double
    variance
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Fields inherited from class AbstractArrayFunction

    dblSource, fltSource, intSource, lngSource, type, TYPE_DBL, TYPE_FLT, TYPE_INT, TYPE_LNG

    Fields inherited from class AbstractFunction

    timeChecker

  • Constructor Summary

    Constructors
    Constructor
    Description
    MeanVarianceArrayFunction(IDoubleArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a mean function on a double array source.
    MeanVarianceArrayFunction(IFloatArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a mean function on a float array source.
    MeanVarianceArrayFunction(IIntArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a mean function on an integer array source.
    MeanVarianceArrayFunction(ILongArraySource source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a mean function on a long array source.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    apply(double[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of double values.
    void
    apply(float[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of float values.
    void
    apply(int[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of integer values.
    void
    apply(long[] data)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Apply the function on a the given array of long values.
    double
    getDoubleValue(Enum<?> variableID)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the double value corresponding to the given variableID

    Methods inherited from class AbstractArrayFunction

    applyFunction

    Methods inherited from class AbstractFunction

    isCheckingTime, onEvent, setCheckingTime, updateSource

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • mean

      protected double mean
      Deprecated, for removal: This API element is subject to removal in a future version.

    • variance

      protected double variance
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • MeanVarianceArrayFunction

      public MeanVarianceArrayFunction(IFloatArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a mean function on a float array source.
      Parameters:
      source - The data source.

    • MeanVarianceArrayFunction

      public MeanVarianceArrayFunction(IIntArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a mean function on an integer array source.
      Parameters:
      source - The data source.

    • MeanVarianceArrayFunction

      public MeanVarianceArrayFunction(ILongArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a mean function on a long array source.
      Parameters:
      source - The data source.

    • MeanVarianceArrayFunction

      public MeanVarianceArrayFunction(IDoubleArraySource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a mean function on a double array source.
      Parameters:
      source - The data source.

  • Method Details

    • apply

      public void apply(double[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of double values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(float[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of float values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(int[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of integer values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • apply

      public void apply(long[] data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractArrayFunction
      Apply the function on a the given array of long values.
      Overrides:
      apply in class AbstractArrayFunction
      Parameters:
      data - A source array of values.

    • getDoubleValue

      public double getDoubleValue(Enum<?> variableID)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IDoubleSource
      Return the double value corresponding to the given variableID
      Specified by:
      getDoubleValue in interface IDoubleSource
      Parameters:
      variableID - A unique identifier for a variable.
      Returns:
      The current double value of the required variable.