Logo
Distributed Genetic Programming Framework
print print

File org.sfc.math.stochastic.statistics.StatisticInfo.java

Here you can find all the information about the file org.sfc.math.stochastic.statistics.StatisticInfo.java. You may explore it here or download it onto your local disk.
/*
 * Copyright (c) 2005 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2005-12-21 09:09:46
 * Original Filename: org.sfc.math.stochastic.statistics.StatisticInfo.java
 * Version          : 2.0.2
 * Last modification: 2006-05-28
 *                by: Thomas Weise
 * 
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *                    
 * Warranty         : This software is provided "as is" 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.
 */

 
package org.sfc.math.stochastic.statistics;

import java.io.Serializable;

import org.sfc.math.stochastic.IStochasticInfo;
import org.sfc.utils.ICloneable;

/**
 * Instances of this class are capable of holding statistical information.
 *
 * @author Thomas Weise
 */

public final  class StatisticInfo  implements  ICloneable, Serializable,
                                               IStochasticInfo
  {
/**
 * The serial version uid.
 */

  private static final long serialVersionUID = 2;
    
/**
 * The count of indiviuals evaluated.
 */

  int     m_count   ;
/**
 * The median value.
 */

  double  m_median  ;
  
/**
 * The minimum value.
 */

  double  m_min     ;
  
/**
 * The maximum value.
 */

  double  m_max     ;
  
/**
 * The avarage value.
 */

  double  m_avg     ;
  
/**
 * The variance of the values.
 */

  double  m_var     ;
  
/**
 * The sum of all visited values.
 */

  double  m_sum     ;
  
/**
 * The sum of the squares of all visited values.
 */

  double  m_sum_sqr ;
  
/**
 * You cannot create a new instance of statistical information directly.
 * Use <code>StatisticInfoBag</code> to do that for you.
 * @see StatisticInfoBag
 */

  StatisticInfo ()
    {
    super();
    clear();
    }
  
/**
 * Obtain the count of elements evaluated.
 * @return  The count of elements evaluated.
 */

  public  final int get_count ()
    {
    return this.m_count;
    }
  
  
/**
 * Obtain the median of the visited collection items.
 * @return The median of the visited collection items.
 */

  public  final double  get_median  ()
    {
    return this.m_median;
    }
  
  
/**
 * Obtain the minimum of the visited collection items.
 * @return The minimum of the visited collection items.
 */

  public  final double  get_minimum  ()
    {
    return this.m_min;
    }
  
/**
 * Obtain the maximum of the visited collection items.
 * @return The maximum of the visited collection items.
 */

  public  final double  get_maximum  ()
    {
    return this.m_max;
    }
  
/**
 * Obtain the average of the visited collection items.
 * @return The average of the visited collection items.
 */

  public  final double  get_average ()
    {
    return this.m_avg;
    }
  
/**
 * Obtain the variance of the visited collection items.
 * @return The variance of the visited collection items.
 */

  public  final double  get_variance ()
    {
    return this.m_var;
    }
  
/**
 * Obtain the standard deviation of the visited collection items.
 * @return The standard deviation of the visited collection items.
 */

  public  final double  get_stddev  ()
    {
    return Math.sqrt(this.m_var);
    }
  
/**
 * Obtain the sum of all elements visited.
 * @return  The sum of all elements visited.
 */

  public  final double  get_sum ()
    {
    return this.m_sum;
    }
  
/**
 * Obtain the sum of the squares of all elements visited.
 * @return The sum of the squares of all elements visited.
 */

  public  final double  get_sum_sqr ()
    {
    return this.m_sum_sqr;
    }
  
/**
 * Reset this statistical information record.
 */

  final void  clear ()
    {
    this.m_count    = 0;
    this.m_avg      = Double.NaN;
    this.m_max      = Double.NaN;
    this.m_median   = Double.NaN;
    this.m_min      = Double.NaN;
    this.m_var      = Double.NaN;
    this.m_sum      = 0.0d;
    this.m_sum_sqr  = 0.0d;
    }
  
  
/**
 * Assign this statistic information record to another one.
 * @param p_info  The statistic information record to copy into this one.
 */

  final void  assign  (final StatisticInfo p_info)
    {
    this.m_count    = p_info.m_count;
    this.m_avg      = p_info.m_avg;
    this.m_max      = p_info.m_max;
    this.m_median   = p_info.m_median;
    this.m_min      = p_info.m_min;
    this.m_var      = p_info.m_var;
    this.m_sum      = p_info.m_sum;
    this.m_sum_sqr  = p_info.m_sum_sqr;
    }
  
/**
 * Creates and returns a copy of this object.  The precise meaning 
 * of "copy" may depend on the class of the object. 
 *
 * @return     A clone of this instance.
 * 
 * @see java.lang.Cloneable
 */

  @Override
  public  final Object  clone ()
    {
    try
      {
      return super.clone();
      }
    catch(Throwable l_t)
      {
      return this;
      }
    }
  }

File Information:

file name:StatisticInfo.java
package:org.sfc.math.stochastic.statistics
qualified name:org.sfc.math.stochastic.statistics.StatisticInfo.java
file type:Java Source File
download location:download http://dgpf.sourceforge.net/source/org/sfc/math/stochastic/statistics/StatisticInfo.java
size:5.422 KB (5553 B)
uploaded: 2015-07-22 04:11:12 GMT+0000
last update: 2006-05-28 13:55:02 GMT+0000
last access: 2018-01-21 23:55:31 GMT+0000

statistics online since 2006-01-02.   RSS Feed
Contact us by sending an email to tweise@gmx.de to receive further information, to report errors, or to join our project.
All content on this site (http://dgpf.sourceforge.net/) is LGPL-licensed.
http://dgpf.sourceforge.net/scripts/source/source.php last modified at 2015-07-22 04:10:53 GMT+0000 served at 2018-01-21 23:55:31 GMT+0000.
Valid CSS Valid XHTML 1.1
Valid RSS SourceForge.net Logo