gov.sandia.cognition.math

Class WeightedRingAverager<RingType extends Ring<RingType>>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.math.WeightedRingAverager<RingType>

Type Parameters:

RingType - Type of Ring to average.

All Implemented Interfaces:

CloneableSerializable, Summarizer<WeightedValue<RingType>,RingType>, java.io.Serializable, java.lang.Cloneable

public class WeightedRingAverager<RingType extends Ring<RingType>>
extends AbstractCloneableSerializable
implements Summarizer<WeightedValue<RingType>,RingType>

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

Since:

3.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WeightedRingAverager() Creates a new instance of WeightedRingAverager

Method Summary

Modifier and Type	Method and Description
RingType	summarize(java.util.Collection<? extends WeightedValue<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

WeightedRingAverager

public WeightedRingAverager()

Creates a new instance of WeightedRingAverager

Method Detail

summarize

public RingType summarize(java.util.Collection<? extends WeightedValue<RingType>> data)

Description copied from interface: Summarizer

Creates a summary of the given collection of data.

Specified by:

summarize in interface Summarizer<WeightedValue<RingType extends Ring<RingType>>,RingType extends Ring<RingType>>

Parameters:

data - The collection of data to summarize.

Returns:

The summary of the data.