Matrix.Align<T, U> Method

Aligns a matrix and a vector on their indexes along the specified dimension.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
public static IIndex? Align<T, U>(
	ref Matrix<T> matrix,
	ref Vector<U> vector,
	Dimension axis,
	JoinType joinType
)

Parameters

matrix  Matrix<T>
The matrix to align. On return the matrix with columns aligned to the combined index.
vector  Vector<U>
The vector to align. On return the vector aligned to the combined index.
axis  Dimension
The axis of matrix whose index should be aligned.
joinType  JoinType
The type of join to use to join the indexes.

Type Parameters

T
The element type of the first matrix.
U
The element type of the second matrix.

Return Value

IIndex
The combined index.

Remarks

The type specified by AutoAlignJoinType is used to join the indexes.

See Also