Sage Modeling and Simulation Library

IHistogram Members

The IHistogram type exposes the following members.

Methods


  Name Description
Public method BiggestBin(HistogramBinCategory)
Returns the index of the biggest bin in each dimension, among the bins identified by the given HistogramBinCategory.
Public method BiggestBin(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the index of the biggest bin in each dimension, among the bins identified by the given low and high bounds.
Public method Clear
Clears this Histogram.
Public method CountEntries(HistogramBinCategory)
Counts the entries in the bins identified by the given HistogramBinCategory.
Public method CountEntries(array<Int32>[]()[][], array<Int32>[]()[][])
Counts the entries in the bins identified by the given low and high bounds.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method Error
This returns a value that indicates how far a specified bin's count deviates from the 'expected' count - note that it is only relevant if the histogram was expected to have been uniform.
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetLabel
Gets the label for the bin at the specified coordiantes.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Recalculate()()()()
Recalculates this Histogram, resulting in new bins and counts.
Public method Recalculate(Array, Array, Int32)
Recalculates the Histogram with new high & low bounds, resulting in new bins and counts.
Public method SmallestBin(HistogramBinCategory)
Returns the index of the smallest bin in each dimension, among the bins identified the given HistogramBinCategory.
Public method SmallestBin(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the index of the smallest bin in each dimension, among the bins identified by the given low and high bounds.
Public method SumEntries(HistogramBinCategory)
Returns the sum of values in all of the bins identified by the given HistogramBinCategory.
Public method SumEntries(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the sum of values in all of the bins identified by the given low and high bounds.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property Bins
Gets the bins that are a part of this Histogram.
Public property Dimension
Gets the number of dimensions in this Histogram (a linear histogram is 1-dimensional.
Public property HighBound
Gets the high bound of the Histogram..
Public property LabelProvider
Gets or sets the label provider.
Public property LowBound
Gets the low bound of the Histogram.
Public property RawData
Gets or sets the raw data that comprises this Histogram.