Histogram.CreateHistogram2D Method

Definition

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

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.

public static Matrix<double> CreateHistogram2D(
	ICategoricalVector rowSamples,
	ICategoricalVector columnSamples
)

Visual Basic

Public Shared Function CreateHistogram2D ( 
	rowSamples As ICategoricalVector,
	columnSamples As ICategoricalVector
) As Matrix(Of Double)

C++/CLI

public:
static Matrix<double>^ CreateHistogram2D(
	ICategoricalVector^ rowSamples, 
	ICategoricalVector^ columnSamples
)

static member CreateHistogram2D : 
        rowSamples : ICategoricalVector * 
        columnSamples : ICategoricalVector -> Matrix<float>

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.

public static Matrix<double> CreateHistogram2D(
	ICategoricalVector rowSamples,
	ICategoricalVector columnSamples,
	Vector<double> weights
)

Visual Basic

Public Shared Function CreateHistogram2D ( 
	rowSamples As ICategoricalVector,
	columnSamples As ICategoricalVector,
	weights As Vector(Of Double)
) As Matrix(Of Double)

C++/CLI

public:
static Matrix<double>^ CreateHistogram2D(
	ICategoricalVector^ rowSamples, 
	ICategoricalVector^ columnSamples, 
	Vector<double>^ weights
)

static member CreateHistogram2D : 
        rowSamples : ICategoricalVector * 
        columnSamples : ICategoricalVector * 
        weights : Vector<float> -> Matrix<float>

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, IntervalIndex)

Returns a two-dimensional histogram of the values in two vectors.

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>

Visual Basic

Public Shared Function CreateHistogram2D(Of T As {Object, IComparable(Of T)}, U As {Object, IComparable(Of U)}) ( 
	rowSamples As Vector(Of T),
	rowBins As IntervalIndex(Of T),
	columnSamples As Vector(Of U),
	columnBins As IntervalIndex(Of U)
) As Matrix(Of Double)

C++/CLI

public:
generic<typename T, typename U>
where T : Object, IComparable<T>
where U : Object, IComparable<U>
static Matrix<double>^ CreateHistogram2D(
	Vector<T>^ rowSamples, 
	IntervalIndex<T>^ rowBins, 
	Vector<U>^ columnSamples, 
	IntervalIndex<U>^ columnBins
)

static member CreateHistogram2D : 
        rowSamples : Vector<'T> * 
        rowBins : IntervalIndex<'T> * 
        columnSamples : Vector<'U> * 
        columnBins : IntervalIndex<'U> -> Matrix<float>  when 'T : Object and IComparable<'T> when 'U : Object and 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: A vector containing values for the column dimension
columnBins IntervalIndex: 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, IntervalIndex, Vector<Double>)

Returns a two-dimensional histogram of the values in two vectors.

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>

Visual Basic

Public Shared Function CreateHistogram2D(Of T As {Object, IComparable(Of T)}, U As {Object, IComparable(Of U)}) ( 
	rowSamples As Vector(Of T),
	rowBins As IntervalIndex(Of T),
	columnSamples As Vector(Of U),
	columnBins As IntervalIndex(Of U),
	weights As Vector(Of Double)
) As Matrix(Of Double)

C++/CLI

public:
generic<typename T, typename U>
where T : Object, IComparable<T>
where U : Object, IComparable<U>
static Matrix<double>^ CreateHistogram2D(
	Vector<T>^ rowSamples, 
	IntervalIndex<T>^ rowBins, 
	Vector<U>^ columnSamples, 
	IntervalIndex<U>^ columnBins, 
	Vector<double>^ weights
)

static member CreateHistogram2D : 
        rowSamples : Vector<'T> * 
        rowBins : IntervalIndex<'T> * 
        columnSamples : Vector<'U> * 
        columnBins : IntervalIndex<'U> * 
        weights : Vector<float> -> Matrix<float>  when 'T : Object and IComparable<'T> when 'U : Object and 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: A vector containing values for the column dimension
columnBins IntervalIndex: 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.

Histogram.CreateHistogram2D Method

Definition

Overload List

CreateHistogram2D(ICategoricalVector, ICategoricalVector)

Parameters

Return Value

Exceptions

CreateHistogram2D(ICategoricalVector, ICategoricalVector, Vector<Double>)

Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference