Histogram.CreateHistogram<T>(Vector<T>, T, T, Int32, Vector<Double>) Method

Returns a histogram of a vector using the specified bin arrangement.

Definition

Namespace: Extreme.DataAnalysis
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

public static Histogram<Interval<T>> CreateHistogram<T>(
	this Vector<T> samples,
	T lowerBound,
	T upperBound,
	int numberOfBins,
	Vector<double> weights
)
where T : Object, IComparable<T>

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T As {Object, IComparable(Of T)}) ( 
	samples As Vector(Of T),
	lowerBound As T,
	upperBound As T,
	numberOfBins As Integer,
	weights As Vector(Of Double)
) As Histogram(Of Interval(Of T))

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
where T : Object, IComparable<T>
static Histogram<Interval<T>>^ CreateHistogram(
	Vector<T>^ samples, 
	T lowerBound, 
	T upperBound, 
	int numberOfBins, 
	Vector<double>^ weights
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : Vector<'T> * 
        lowerBound : 'T * 
        upperBound : 'T * 
        numberOfBins : int * 
        weights : Vector<float> -> Histogram<Interval<'T>>  when 'T : Object and IComparable<'T>

Parameters

samples Vector<T>: A vector.
lowerBound T: The lower bound of the first histogram bin.
upperBound T: The upper bound of the last histogram bin.
numberOfBins Int32: The number of bins.
weights Vector<Double>: A vector that supplies weights for the values in samples.

Type Parameters

T: The type of the values.

Return Value

Histogram<Interval<T>>
A vector that contains a histogram of the total weight of the binned values in samples weighted by weights.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

samples is null.

-or-

weights is null.

DimensionMismatchException

samples and weights do not have the same length.