Histogram.CreateHistogram Method

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

CreateHistogram(ICategoricalVector)	Returns a histogram of the counts for each value in a vector.
CreateHistogram<T>(CategoricalVector<T>)	Returns a new histogram of the counts for each value in a vector.
CreateHistogram<T>(CategoricalVector<T>, Vector<Double>)	Returns a new histogram of the counts for each value in a vector.
CreateHistogram<T>(IList<T>, IntervalIndex<T>)	Returns a histogram of a vector using the specified bin arrangement.
CreateHistogram<T>(IList<T>, IntervalIndex<T>, IList<Double>)	Returns a histogram of a vector using the specified bin arrangement.
CreateHistogram<T>(IList<T>, T, T, Int32, SpecialBins)	Returns a histogram of a vector using the specified bin arrangement.
CreateHistogram<T>(Vector<T>, T, T, Int32, Vector<Double>)	Returns a histogram of a vector using the specified bin arrangement.

CreateHistogram<T>(CategoricalVector<T>)

Returns a new histogram of the counts for each value in a vector.

public static Histogram<T> CreateHistogram<T>(
	this CategoricalVector<T> samples
)

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T) ( 
	samples As CategoricalVector(Of T)
) As Histogram(Of T)

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static Histogram<T>^ CreateHistogram(
	CategoricalVector<T>^ samples
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : CategoricalVector<'T> -> Histogram<'T>

Parameters

samples CategoricalVector<T>: A categorical vector.

Type Parameters

T

Return Value

Histogram<T>
A vector that contains a histogram of the total weight of each unique value in samples.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type CategoricalVector<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.

CreateHistogram(ICategoricalVector)

Returns a histogram of the counts for each value in a vector.

public static Vector<double> CreateHistogram(
	this ICategoricalVector samples
)

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram ( 
	samples As ICategoricalVector
) As Vector(Of Double)

C++/CLI

public:
[ExtensionAttribute]
static Vector<double>^ CreateHistogram(
	ICategoricalVector^ samples
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : ICategoricalVector -> Vector<float>

Parameters

samples ICategoricalVector: A vector.

Return Value

Vector<Double>
A vector that contains a histogram of the values in samples.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ICategoricalVector. 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.

CreateHistogram<T>(CategoricalVector<T>, Vector<Double>)

Returns a new histogram of the counts for each value in a vector.

public static Histogram<T> CreateHistogram<T>(
	this CategoricalVector<T> samples,
	Vector<double> weights
)

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T) ( 
	samples As CategoricalVector(Of T),
	weights As Vector(Of Double)
) As Histogram(Of T)

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static Histogram<T>^ CreateHistogram(
	CategoricalVector<T>^ samples, 
	Vector<double>^ weights
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : CategoricalVector<'T> * 
        weights : Vector<float> -> Histogram<'T>

Parameters

samples CategoricalVector<T>: A vector.
weights Vector<Double>: A vector that supplies weights for the values in samples.

Type Parameters

T

Return Value

Histogram<T>
A vector that contains a histogram of the total weight of each unique value in samples, weighted by the weights.

Usage Note

Exceptions

ArgumentNullException

samples is null.

-or-

weights is null.

DimensionMismatchException

samples and weights do not have the same length.

CreateHistogram<T>(IList<T>, IntervalIndex<T>)

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

public static Histogram<Interval<T>> CreateHistogram<T>(
	this IList<T> samples,
	IntervalIndex<T> bins
)
where T : Object, IComparable<T>

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T As {Object, IComparable(Of T)}) ( 
	samples As IList(Of T),
	bins As IntervalIndex(Of T)
) As Histogram(Of Interval(Of T))

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
where T : Object, IComparable<T>
static Histogram<Interval<T>>^ CreateHistogram(
	IList<T>^ samples, 
	IntervalIndex<T>^ bins
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : IList<'T> * 
        bins : IntervalIndex<'T> -> Histogram<Interval<'T>>  when 'T : Object and IComparable<'T>

Parameters

samples IList<T>: A vector.
bins IntervalIndex<T>: An interval index that specifies the bin boundaries.

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.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IList<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-

bins is null.

CreateHistogram<T>(IList<T>, IntervalIndex<T>, IList<Double>)

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

public static Histogram<Interval<T>> CreateHistogram<T>(
	this IList<T> samples,
	IntervalIndex<T> bins,
	IList<double> weights
)
where T : Object, IComparable<T>

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T As {Object, IComparable(Of T)}) ( 
	samples As IList(Of T),
	bins As IntervalIndex(Of T),
	weights As IList(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(
	IList<T>^ samples, 
	IntervalIndex<T>^ bins, 
	IList<double>^ weights
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : IList<'T> * 
        bins : IntervalIndex<'T> * 
        weights : IList<float> -> Histogram<Interval<'T>>  when 'T : Object and IComparable<'T>

Parameters

samples IList<T>: A vector.
bins IntervalIndex<T>: An interval index that specifies the bin boundaries.
weights IList<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.

Usage Note

Exceptions

ArgumentNullException

samples is null.

-or-

bins is null.

-or-

weights is null.

DimensionMismatchException

samples and weights do not have the same length.

CreateHistogram<T>(IList<T>, T, T, Int32, SpecialBins)

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

public static Histogram<Interval<T>> CreateHistogram<T>(
	this IList<T> samples,
	T lowerBound,
	T upperBound,
	int numberOfBins,
	SpecialBins specialBins = SpecialBins.None
)
where T : Object, IComparable<T>

Visual Basic

<ExtensionAttribute>
Public Shared Function CreateHistogram(Of T As {Object, IComparable(Of T)}) ( 
	samples As IList(Of T),
	lowerBound As T,
	upperBound As T,
	numberOfBins As Integer,
	Optional specialBins As SpecialBins = SpecialBins.None
) As Histogram(Of Interval(Of T))

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
where T : Object, IComparable<T>
static Histogram<Interval<T>>^ CreateHistogram(
	IList<T>^ samples, 
	T lowerBound, 
	T upperBound, 
	int numberOfBins, 
	SpecialBins specialBins = SpecialBins::None
)

[<ExtensionAttribute>]
static member CreateHistogram : 
        samples : IList<'T> * 
        lowerBound : 'T * 
        upperBound : 'T * 
        numberOfBins : int * 
        ?specialBins : SpecialBins 
(* Defaults:
        let _specialBins = defaultArg specialBins SpecialBins.None
*)
-> Histogram<Interval<'T>>  when 'T : Object and IComparable<'T>

Parameters

samples IList<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.
specialBins SpecialBins (Optional): (Optional.) A SpecialBins value that specifies which special bins, if any, to include in the histogram.

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.

Usage Note

Exceptions

ArgumentNullException

samples is null.

CreateHistogram<T>(Vector<T>, T, T, Int32, Vector<Double>)

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

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.

Histogram.CreateHistogram Method

Definition

Overload List

CreateHistogram<T>(CategoricalVector<T>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

CreateHistogram(ICategoricalVector)

Parameters

Return Value

Usage Note

Exceptions

CreateHistogram<T>(CategoricalVector<T>, Vector<Double>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

CreateHistogram<T>(IList<T>, IntervalIndex<T>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

CreateHistogram<T>(IList<T>, IntervalIndex<T>, IList<Double>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

CreateHistogram<T>(IList<T>, T, T, Int32, SpecialBins)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

CreateHistogram<T>(Vector<T>, T, T, Int32, Vector<Double>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

See Also

Reference