This is documentation for an old release of Numerics.NET (version 8.1). Read this page in the documentation of the latest stable release (version 9.0).

Matrix.Align<T, U> Method

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

Definition

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

C#

public static IIndex Align<T, U>(
	ref Matrix<T> matrix,
	ref Vector<U> vector,
	Dimension axis,
	JoinType joinType
)

Visual Basic

Public Shared Function Align(Of T, U) ( 
	ByRef matrix As Matrix(Of T),
	ByRef vector As Vector(Of U),
	axis As Dimension,
	joinType As JoinType
) As IIndex

C++/CLI

public:
generic<typename T, typename U>
static IIndex^ Align(
	Matrix<T>^% matrix, 
	Vector<U>^% vector, 
	Dimension axis, 
	JoinType joinType
)

F#

static member Align : 
        matrix : Matrix<'T> byref * 
        vector : Vector<'U> byref * 
        axis : Dimension * 
        joinType : JoinType -> IIndex

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
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

Reference

Extreme.Mathematics Namespace