Histogram.CreateHistogram2D Method

Definition

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

Overload List

CreateHistogram2D(ICategoricalVector, ICategoricalVector) Returns a two-dimensional histogram of the values in two categorical vectors.
CreateHistogram2D(ICategoricalVector, ICategoricalVector, Vector<Double>) Returns a two-dimensional histogram of the values in two categorical vectors.
CreateHistogram2D<T, U>(Vector<T>, IntervalIndex<T>, Vector<U>, IntervalIndex<U>) Returns a two-dimensional histogram of the values in two vectors.
CreateHistogram2D<T, U>(Vector<T>, IntervalIndex<T>, Vector<U>, IntervalIndex<U>, Vector<Double>) Returns a two-dimensional histogram of the values in two vectors.

CreateHistogram2D(ICategoricalVector, ICategoricalVector)

Returns a two-dimensional histogram of the values in two categorical vectors.
C#
public static Matrix<double> CreateHistogram2D(
	ICategoricalVector rowSamples,
	ICategoricalVector columnSamples
)

Parameters

rowSamples  ICategoricalVector
A categorical vector containing values for the row dimension.
columnSamples  ICategoricalVector
A categorical vector containing values for the column dimension

Return Value

Matrix<Double>
A matrix containing a histogram of the unique values in rowSamples and columnSamples.

Exceptions

ArgumentNullException

rowSamples is null.

-or-

columnSamples is null.

DimensionMismatchException

rowSamples and columnSamples do not have the same length.

CreateHistogram2D(ICategoricalVector, ICategoricalVector, Vector<Double>)

Returns a two-dimensional histogram of the values in two categorical vectors.
C#
public static Matrix<double> CreateHistogram2D(
	ICategoricalVector rowSamples,
	ICategoricalVector columnSamples,
	Vector<double> weights
)

Parameters

rowSamples  ICategoricalVector
A categorical vector containing values for the row dimension.
columnSamples  ICategoricalVector
A categorical vector containing values for the column dimension
weights  Vector<Double>
A vector that supplies weights for the samples.

Return Value

Matrix<Double>
A matrix containing a histogram of the unique values in rowSamples and columnSamples.

Exceptions

ArgumentNullException

rowSamples is null.

-or-

columnSamples is null.

-or-

weights is null.

DimensionMismatchException

rowSamples and columnSamples do not have the same length.

-or-

rowSamples and weights do not have the same length.

CreateHistogram2D<T, U>(Vector<T>, IntervalIndex<T>, Vector<U>, IntervalIndex<U>)

Returns a two-dimensional histogram of the values in two vectors.
C#
public static Matrix<double> CreateHistogram2D<T, U>(
	Vector<T> rowSamples,
	IntervalIndex<T> rowBins,
	Vector<U> columnSamples,
	IntervalIndex<U> columnBins
)
where T : Object, IComparable<T>
where U : Object, IComparable<U>

Parameters

rowSamples  Vector<T>
A vector containing values for the row dimension.
rowBins  IntervalIndex<T>
An interval index that specifies the bins for rowSamples.
columnSamples  Vector<U>
A vector containing values for the column dimension
columnBins  IntervalIndex<U>
An interval index that specifies the bins for columnSamples.

Type Parameters

T
The type of the row samples.
U
The type of the column samples.

Return Value

Matrix<Double>
A matrix containing a histogram of the values in rowSamples and columnSamples, binned using rowBins and columnBins.

Exceptions

ArgumentNullException

rowSamples is null.

-or-

columnSamples is null.

-or-

rowBins is null.

-or-

columnBins is null.

DimensionMismatchException

rowSamples and columnSamples do not have the same length.

CreateHistogram2D<T, U>(Vector<T>, IntervalIndex<T>, Vector<U>, IntervalIndex<U>, Vector<Double>)

Returns a two-dimensional histogram of the values in two vectors.
C#
public static Matrix<double> CreateHistogram2D<T, U>(
	Vector<T> rowSamples,
	IntervalIndex<T> rowBins,
	Vector<U> columnSamples,
	IntervalIndex<U> columnBins,
	Vector<double> weights
)
where T : Object, IComparable<T>
where U : Object, IComparable<U>

Parameters

rowSamples  Vector<T>
A vector containing values for the row dimension.
rowBins  IntervalIndex<T>
An interval index that specifies the bins for rowSamples.
columnSamples  Vector<U>
A vector containing values for the column dimension
columnBins  IntervalIndex<U>
An interval index that specifies the bins for columnSamples.
weights  Vector<Double>
A vector that supplies weights for the samples.

Type Parameters

T
The type of the row samples.
U
The type of the column samples.

Return Value

Matrix<Double>
A matrix containing a histogram of the values in rowSamples and columnSamples, binned using rowBins and columnBins.

Exceptions

ArgumentNullException

rowSamples is null.

-or-

columnSamples is null.

-or-

rowBins is null.

-or-

columnBins is null.

-or-

weights is null.

DimensionMismatchException

rowSamples and columnSamples do not have the same length.

See Also