Struct np.Histogram2dResult

Namespace

NumSharp

Assembly

NumSharp.dll

The bi-dimensional histogram plus its two edge arrays — the three values NumPy's histogram2d returns. Converts implicitly to NDArray (the histogram H) and deconstructs as var (H, xedges, yedges) = np.histogram2d(x, y);.

public readonly struct np.Histogram2dResult : INDArrayCarrier

Implements

INDArrayCarrier

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

H

The 2-D histogram, shape (nx, ny), dtype float64.

public readonly NDArray H

Field Value

NDArray

xedges

The bin edges along the first (x) dimension.

public readonly NDArray xedges

Field Value

NDArray

yedges

The bin edges along the second (y) dimension.

public readonly NDArray yedges

Field Value

NDArray

Methods

Deconstruct(out NDArray, out NDArray, out NDArray)

Deconstructs into (H, xedges, yedges).

public void Deconstruct(out NDArray h, out NDArray xedges, out NDArray yedges)

Parameters

h NDArray

Receives the histogram.

xedges NDArray

Receives the x edges.

yedges NDArray

Receives the y edges.

Operators

implicit operator NDArray(Histogram2dResult)

Yields the primary result — the histogram H.

public static implicit operator NDArray(np.Histogram2dResult r)

Parameters

r np.Histogram2dResult

The result to unwrap.

Returns

NDArray