Documentation of 'umontreal.iro.lecuyer.stat.list.ListOfTalliesWithCovariance' Java class
ListOfTalliesWithCovariance
Skip navigation links
umontreal.iro.lecuyer.stat.list

Class ListOfTalliesWithCovariance<E extends Tally>

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess

    public class ListOfTalliesWithCovariance<E extends Tally>
extends ListOfTallies<E>
    Extends ListOfTallies to add support for the computation of the sample covariance between each pair of elements in a list, without storing all observations. This list of tallies contains internal structures to keep track of bar(X)n, i for i = 0,…, d - 1, and ∑k=0n-1(Xi, k - bar(X)k, i)(Xj, k - bar(X)k, j)/n, for i = 0,…, d - 2 and j = 1,…, d - 1, with j > i. Here, bar(X)n, i is the ith component of bar(X)n, the average vector, and bar(X)0, i = 0 for i = 0,…, d - 1. The value Xi, k corresponds to the ith component of the kth observation Xk. These sums are updated every time a vector is added to this list, and are used to estimate the covariances.

    Note: the size of the list of tallies must remain fixed because of the data structures used for computing sample covariances. As a result, the first call to init makes this list unmodifiable.

    Note: for the sample covariance to be computed between a pair of tallies, the number of observations in each tally should be the same. It is therefore recommended to always add complete vectors of observations to this list. Moreover, one must use the add method in this class to add vectors of observations for the sums used for covariance estimation to be updated correctly. Failure to use this method, e.g., adding observations to each individual tally in the list, will result in an incorrect estimate of the covariances, unless the tallies in the list can store observations. For example, the following code, which adds the vector v in the list of tallies list, works correctly only if the list contains instances of TallyStore:

    for (int i = 0; i < v.length; i++)
          list.get (i).add (v[i]);
    But the following code is always correct:
    list.add (v);

    • Constructor Detail

      • ListOfTalliesWithCovariance

        public ListOfTalliesWithCovariance()
        Creates an empty list of tallies with covariance support. One must fill the list with tallies, and call init before adding any observation.

      • ListOfTalliesWithCovariance

        public ListOfTalliesWithCovariance(java.lang.String name)
        Creates an empty list of tallies with covariance support and name name. One must fill the list with tallies, and call init before adding any observation.
        Parameters:
        name - the name of the new list.

    • Method Detail

      • createWithTally

        public static ListOfTalliesWithCovariance<Tally> createWithTally(int size)
        This factory method constructs and returns a list of tallies with size instances of Tally.
        Parameters:
        size - the size of the list.
        Returns:
        the created list.

      • createWithTallyStore

        public static ListOfTalliesWithCovariance<TallyStore> createWithTallyStore(int size)
        This factory method constructs and returns a list of tallies with size instances of TallyStore.
        Parameters:
        size - the size of the list.
        Returns:
        the created list.

      • add

        public void add(double[] x)
        Adds a new vector of observations x to this list of tallies, and updates the internal data structures computing averages, and sums of products. One must use this method instead of adding observations to individual tallies to get a covariance estimate.
        Overrides:
        add in class ListOfTallies<E extends Tally>
        Parameters:
        x - the new vector of observations.

      • covariance

        public double covariance(int i,
                         int j)
        Description copied from class: ListOfTallies
        Returns the empirical covariance of the observations in tallies with indices i and j. If x1,…, xn represent the observations in tally i whereas y1,…, yn represent the observations in tally j, then the covariance is given by

        SX, Y = $\displaystyle {\frac{{1}}{{n-1}}}$∑k=1n(xk - bar(X)n)(yk - bar(Y)n) = [tex2html_wrap_indisplay275](∑k=1nxkyk - $\displaystyle {\frac{{1}}{{n}}}$∑k=1nxk∑r=1nyr).

        This returns Double.NaN if the tallies do not contain the same number of observations, or if they contain less than two observations. This method throws an exception if the underlying tallies are not capable of storing observations, i.e. if the tallies are not TallyStores. The ListOfTalliesWithCovariance subclass provides an alternative implementation of this method which does not require the observations to be stored.
        Overrides:
        covariance in class ListOfTallies<E extends Tally>
        Parameters:
        i - the index of the first tally.
        j - the index of the second tally.
        Returns:
        the value of the covariance.

      • clone

        public ListOfTalliesWithCovariance<E> clone()
        Clones this object. This clones the list of tallies and the data structures holding the sums of products but not the tallies comprising the list. The created clone is modifiable, even though the original list is unmodifiable.
        Overrides:
        clone in class ListOfTallies<E extends Tally>
Skip navigation links

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.