org.opensha.commons.data.estimate
Class IntegerEstimate

java.lang.Object
  extended by org.opensha.commons.data.estimate.Estimate
      extended by org.opensha.commons.data.estimate.DiscretizedFuncEstimate
          extended by org.opensha.commons.data.estimate.DiscreteValueEstimate
              extended by org.opensha.commons.data.estimate.IntegerEstimate

public class IntegerEstimate
extends DiscreteValueEstimate

Title: IntegerEstimate.java

Description: This can be used to specify probabilities associated with discrete values from an ArbitrarilyDiscretizedFunction. the discrete Values should be integer values.

Copyright: Copyright (c) 2002

Company:

Version:
1.0
Author:
not attributable

Field Summary
static String NAME
           
 
Fields inherited from class org.opensha.commons.data.estimate.DiscretizedFuncEstimate
cumDistFunc, func, tol
 
Fields inherited from class org.opensha.commons.data.estimate.Estimate
comments, EST_MSG_FIRST_LAST_PROB_ZERO, EST_MSG_INVLID_RANGE, EST_MSG_MAX_LT_MIN, EST_MSG_NOT_NORMALIZED, EST_MSG_PROB_POSITIVE, EST_MSG_PROBS_NOT_INCREASING, FRACTILE_UNDEFINED, max, MEDIAN_UNDEFINED, min, MSG_ALL_PROB_ZERO, MSG_INVALID_STDDEV, units
 
Constructor Summary
IntegerEstimate(ArbitrarilyDiscretizedFunc func, boolean isNormalized)
          Constructor - Accepts DiscretizedFunc & an indication of whether it's already normized.
 
Method Summary
 void checkValues()
          It checks whether values (on X Axis) are indeed integers:
 String getName()
          Return the name of the estimate.
 
Methods inherited from class org.opensha.commons.data.estimate.DiscreteValueEstimate
getCDF_Test, getPDF_Test, getProbLessThanEqual, getRandomValue
 
Methods inherited from class org.opensha.commons.data.estimate.DiscretizedFuncEstimate
getDiscreteFractile, getFractile, getFunc, getMean, getMedian, getMode, getStdDev, getValues, isMultiModal, setTolerance, setValues, toString
 
Methods inherited from class org.opensha.commons.data.estimate.Estimate
getCDF_TestUsingFractile, getComments, getMax, getMin, getUnits, isNegativeValuePresent, setComments, setUnits
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values
Constructor Detail

IntegerEstimate

public IntegerEstimate(ArbitrarilyDiscretizedFunc func,
                       boolean isNormalized)
Constructor - Accepts DiscretizedFunc & an indication of whether it's already normized. It checks that the values(along X Axis) in the function are integers (or withing tolerance of integers)

Parameters:
func - DiscretizedFunc containing the X and Y values
Method Detail

checkValues

public void checkValues()
It checks whether values (on X Axis) are indeed integers:

Parameters:
func - ArbitrarilyDiscretizedFunc containing the values and probabilities

getName

public String getName()
Description copied from class: DiscreteValueEstimate
Return the name of the estimate. This is the name visible to the user

Overrides:
getName in class DiscreteValueEstimate
Returns: