Matrix.CopyFromSkewSymmetric Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.5.0

Overload List

CopyFromSkewSymmetric<T>(Matrix<T>, MatrixTriangle, ArrayMutability) Returns an independent copy of a matrix made skew-symmetric using one triangle.
CopyFromSkewSymmetric<T>(Matrix<T>, Int32, MatrixTriangle, ArrayMutability) Returns an independent copy of a matrix made skew-symmetric using one triangle, with an explicit size.

CopyFromSkewSymmetric<T>(Matrix<T>, MatrixTriangle, ArrayMutability)

Returns an independent copy of a matrix made skew-symmetric using one triangle.
C#
public static Matrix<T> CopyFromSkewSymmetric<T>(
	Matrix<T> source,
	MatrixTriangle triangle = MatrixTriangle.Upper,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Parameters

source  Matrix<T>
The source matrix.
triangle  MatrixTriangle  (Optional)
Specifies which triangle of source holds the authoritative values. The default is Upper.
mutability  ArrayMutability  (Optional)
The desired mutability of the copy. The default is MutableValues.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
A matrix where off-diagonal element [i,j] equals the negation of [j,i], and diagonal elements are zero.

Exceptions

ArgumentNullException

source is null.

CopyFromSkewSymmetric<T>(Matrix<T>, Int32, MatrixTriangle, ArrayMutability)

Returns an independent copy of a matrix made skew-symmetric using one triangle, with an explicit size.
C#
public static Matrix<T> CopyFromSkewSymmetric<T>(
	Matrix<T> source,
	int size,
	MatrixTriangle triangle = MatrixTriangle.Upper,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Parameters

source  Matrix<T>
The source matrix.
size  Int32
The number of rows and columns of the copy. Must be between 0 and the smaller of the row count and column count of source (inclusive).
triangle  MatrixTriangle  (Optional)
Specifies which triangle of source holds the authoritative values. The default is Upper.
mutability  ArrayMutability  (Optional)
The desired mutability of the copy. The default is MutableValues.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
A new size×size matrix where off-diagonal element [i,j] equals the negation of [j,i], and diagonal elements are zero.

Exceptions

ArgumentNullException

source is null.

ArgumentOutOfRangeException

size is less than 0 or greater than the smaller of the row count and column count of source.

See Also