Histogram.CreateEmpty Method

Definition

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

Overload List

CreateEmpty(Int32, Int32) Returns an empty histogram using the specified bin arrangement.
CreateEmpty<T>(Index<T>) Returns a histogram of a vector using the specified bin arrangement.
CreateEmpty<T>(IList<T>, SpecialBins) Returns an empty histogram using the specified bin arrangement.
CreateEmpty<T>(T, T, Int32) Returns an empty histogram using the specified bin arrangement.

CreateEmpty<T>(Index<T>)

Returns a histogram of a vector using the specified bin arrangement.
C#
public static Histogram<T> CreateEmpty<T>(
	Index<T> bins
)
where T : Object, IComparable<T>

Parameters

bins  Index<T>
An interval index that specifies the bin boundaries.

Type Parameters

T
The type of the values.

Return Value

Histogram<T>
An empty histogram with bins defined by bins.

Exceptions

CreateEmpty<T>(IList<T>, SpecialBins)

Returns an empty histogram using the specified bin arrangement.
C#
public static Histogram<Interval<T>> CreateEmpty<T>(
	IList<T> bounds,
	SpecialBins specialBins = SpecialBins.None
)
where T : Object, IComparable<T>

Parameters

bounds  IList<T>
A list that specifies the boundaries of the intervals. The values in this list must be in increasing order.
specialBins  SpecialBins  (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>>

CreateEmpty(Int32, Int32)

Returns an empty histogram using the specified bin arrangement.
C#
public static Histogram<int> CreateEmpty(
	int lowerBound,
	int upperBound
)

Parameters

lowerBound  Int32
The (inclusive) lower bound of the first histogram bin.
upperBound  Int32
The (exclusive) upper bound of the last histogram bin.

Return Value

Histogram<Int32>
An empty histogram containing bins labeled with values from lowerBound (inclusive) to upperBound (exclusive). .

CreateEmpty<T>(T, T, Int32)

Returns an empty histogram using the specified bin arrangement.
C#
public static Histogram<Interval<T>> CreateEmpty<T>(
	T lowerBound,
	T upperBound,
	int numberOfBins = 10
)
where T : Object, IComparable<T>

Parameters

lowerBound  T
The lower bound of the first histogram bin.
upperBound  T
The upper bound of the last histogram bin.
numberOfBins  Int32  (Optional)
The number of bins.

Type Parameters

T
The type of the values.

Return Value

Histogram<Interval<T>>
An empty histogram containing numberOfBins bins with boundaries between lowerBound and upperBound. .

See Also