gov.sandia.cognition.statistics.AbstractSufficientStatistic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gov-sandia-cognition-learning-core Show documentation

Algorithms and components for machine learning and statistics.

The newest version!

/*
 * File:                AbstractSufficientStatistic.java
 * Authors:             Kevin R. Dixon
 * Company:             Sandia National Laboratories
 * Project:             Cognitive Foundry
 * 
 * Copyright Mar 2, 2011, Sandia Corporation.
 * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
 * license for use of this work by or on behalf of the U.S. Government.
 * Export of this program may require a license from the United States
 * Government. See CopyrightHistory.txt for complete details.
 * 
 */

package gov.sandia.cognition.statistics;

import gov.sandia.cognition.util.AbstractCloneableSerializable;

/**
 * Partial implementation of SufficientStatistic
 * @param 
 * Type of data generated by the Distribution
 * @param 
 * Type of Distribution this is the sufficient statistics of
 * @author Kevin R. Dixon
 * @since 3.1
 */
public abstract class AbstractSufficientStatistic// extends Distribution>
    extends AbstractCloneableSerializable
    implements SufficientStatistic
{

    /**
     * Number of data points used to create this SufficientStatistic
     */
    protected long count;

    /** 
     * Creates a new instance of AbstractSufficientStatistic
     */
    public AbstractSufficientStatistic()
    {
        super();
        this.setCount(0);
    }

    @Override
    @SuppressWarnings("unchecked")
    public AbstractSufficientStatistic clone()
    {
        return (AbstractSufficientStatistic) super.clone();
    }

    @Override
    public void update(
        final Iterable values)
    {
        for( DataType value : values )
        {
            this.update( value );
        }
    }

    @Override
    public long getCount()
    {
        return this.count;
    }

    /**
     * Setter for count
     * @param count
     * Number of data points used to create this SufficientStatistic
     */
    protected void setCount(
        final long count)
    {
        this.count = count;
    }

}