Aligns a matrix and a vector on their indexes along the specified dimension.
Namespace:
Extreme.Mathematics
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public static IIndex Align<T, U>(
ref Matrix<T> matrix,
ref Vector<U> vector,
Dimension axis,
JoinType joinType
)
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
public:
generic<typename T, typename U>
static IIndex^ Align(
Matrix<T>^% matrix,
Vector<U>^% vector,
Dimension axis,
JoinType joinType
)
static member Align :
matrix : Matrix<'T> byref *
vector : Vector<'U> byref *
axis : Dimension *
joinType : JoinType -> IIndex
Parameters
- matrix
- Type: Extreme.MathematicsMatrixT
The matrix to align. On return
the matrix with columns aligned to the combined index. - vector
- Type: Extreme.MathematicsVectorU
The vector to align. On return
the vector aligned to the combined index. - axis
- Type: Extreme.MathematicsDimension
- joinType
- Type: Extreme.DataAnalysisJoinType
The type of join to use to join the indexes.
Type Parameters
- T
- The element type of the matrix1 matrix.
- U
- The element type of the matrix2 matrix.
Return Value
Type:
IIndexThe combined index.
The type specified by
AutoAlignJoinType
is used to join the indexes.
Reference