Package microsim.statistics.functions

Class MeanVarianceArrayFunction

  • All Implemented Interfaces:
    EventListener, IDoubleSource, IUpdatableSource
    public class MeanVarianceArrayFunction
extends AbstractArrayFunction
implements IDoubleSource
    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

    • Constructor Detail

      • MeanVarianceArrayFunction

        public MeanVarianceArrayFunction​(IFloatArraySource source)
        Create a mean function on a float array source.
        Parameters:
        source - The data source.

      • MeanVarianceArrayFunction

        public MeanVarianceArrayFunction​(IIntArraySource source)
        Create a mean function on an integer array source.
        Parameters:
        source - The data source.

      • MeanVarianceArrayFunction

        public MeanVarianceArrayFunction​(ILongArraySource source)
        Create a mean function on a long array source.
        Parameters:
        source - The data source.

      • MeanVarianceArrayFunction

        public MeanVarianceArrayFunction​(IDoubleArraySource source)
        Create a mean function on a double array source.
        Parameters:
        source - The data source.

    • Method Detail

      • apply

        public void apply​(double[] data)
        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)
        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)
        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)
        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​(java.lang.Enum<?> variableID)
        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.