gov.sandia.cognition.math
Class RingAverager<RingType extends Ring<RingType>>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.math.RingAverager<RingType>
Type Parameters:
RingType - Type of Ring to average
All Implemented Interfaces:
CloneableSerializable, Summarizer<RingType,RingType>, Serializable, Cloneable

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-26",
            changesNeeded=false,
            comments="Looks good.")
public class RingAverager<RingType extends Ring<RingType>>
extends AbstractCloneableSerializable
implements Summarizer<RingType,RingType>

A type of Averager for Rings (Matrices, Vectors, ComplexNumbers). Returns the arithmetic mean of a Collection of Rings

Since:
1.0
Author:
Kevin R. Dixon
See Also:
Serialized Form

Constructor Summary
RingAverager()
          Creates a new instance of RingAverager
 
Method Summary
 RingType summarize(Collection<? extends RingType> data)
          Creates a summary of the given collection of data.
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RingAverager

public RingAverager()
Creates a new instance of RingAverager

Method Detail

summarize

public RingType summarize(Collection<? extends RingType> data)
Description copied from interface: Summarizer
Creates a summary of the given collection of data.

Specified by:
summarize in interface Summarizer<RingType extends Ring<RingType>,RingType extends Ring<RingType>>
Parameters:
data - The collection of data to summarize.
Returns:
The summary of the data.