MatrixF Class

MatrixF Class

Defines an m x n matrix (single-precision).

Inheritance Hierarchy

SystemObject
DigitalRune.Mathematics.AlgebraMatrixF

Namespace: DigitalRune.Mathematics.Algebra
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class MatrixF : IEquatable<MatrixF>, 
	ISerializable, IXmlSerializable

<SerializableAttribute>
<TypeConverterAttribute(GetType(ExpandableObjectConverter))>
Public Class MatrixF
	Implements IEquatable(Of MatrixF), ISerializable, 
	IXmlSerializable

[SerializableAttribute]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class MatrixF : IEquatable<MatrixF^>, 
	ISerializable, IXmlSerializable

[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type MatrixF =  
    class
        interface IEquatable<MatrixF>
        interface ISerializable
        interface IXmlSerializable
    end

The MatrixF type exposes the following members.

Constructors

	Name	Description
	MatrixF	Initializes a new instance of the MatrixF class with 4 x 4 matrix elements.
	MatrixF(Single)	Initializes a new instance of the MatrixF class.
	MatrixF(Single)	Initializes a new instance of the MatrixF class.
	MatrixF(Int32, Int32)	Initializes a new instance of the MatrixF class.
	MatrixF(SerializationInfo, StreamingContext)	Initializes a new instance of the MatrixF class with serialized data.
	MatrixF(Int32, Int32, Single)	Initializes a new instance of the MatrixF class. Each element is set to value.
	MatrixF(Int32, Int32, IListSingle, MatrixOrder)	Initializes a new instance of the MatrixF class.
	MatrixF(Int32, Int32, Single, MatrixOrder)	Initializes a new instance of the MatrixF class.

Top

Methods

	Name	Description
	Absolute	Sets each matrix element to its absolute value.
	Absolute(MatrixF)	Returns a matrix with the absolute values of the elements of the given matrix.
	Add	Adds two matrices.
	AreNumericallyEqual(MatrixF, MatrixF)	Determines whether two matrices are equal (regarding the tolerance EpsilonF).
	AreNumericallyEqual(MatrixF, MatrixF, Single)	Determines whether two matrices are equal (regarding a specific tolerance).
	ClampToZero	Clamps near-zero matrix elements to zero.
	ClampToZero(Single)	Clamps near-zero matrix elements to zero.
	ClampToZero(MatrixF)	Returns a matrix with the matrix elements clamped to the range [min, max].
	ClampToZero(MatrixF, Single)	Returns a matrix with the matrix elements clamped to the range [min, max].
	Clone	Clones this instance.
	CreateIdentity	Creates an identity matrix.
	Divide	Divides a matrix by a scalar.
	Equals(Object)	Indicates whether this instance and a specified object are equal. (Overrides ObjectEquals(Object).)
	Equals(MatrixF)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetColumn	Gets the column with the given index.
	GetHashCode	Returns the hash code for this instance. (Overrides ObjectGetHashCode.)
	GetMinor	Gets the minor matrix.
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetRow	Gets the row with the given index.
	GetSchema	This property is reserved, apply the XmlSchemaProviderAttribute to the class instead.
	GetSubmatrix(Int32, Int32)	Gets a submatrix of this matrix.
	GetSubmatrix(Int32, Int32, Int32)	Gets a submatrix of this matrix.
	GetSubmatrix(Int32, Int32, Int32)	Gets a submatrix of this matrix.
	GetSubmatrix(Int32, Int32, Int32, Int32)	Gets a submatrix of this matrix.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invert	Inverts the matrix.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Multiply(Single, MatrixF)	Multiplies a matrix by a scalar.
	Multiply(MatrixF, MatrixF)	Multiplies two matrices.
	Multiply(MatrixF, VectorF)	Multiplies a matrix with a column vector.
	Negate	Negates a matrix.
	ReadXml	Generates an object from its XML representation.
	Set(Single)	Sets the matrix elements to the specified value.
	Set(Single)	Sets the matrix elements to the values of the array.
	Set(Single)	Sets the matrix elements to the values of the array.
	Set(MatrixF)	Sets the elements of this matrix.
	Set(IListSingle, MatrixOrder)	Sets the matrix elements to the values of the list.
	Set(Single, MatrixOrder)	Sets the matrix elements to the values of the array.
	SetColumn	Sets a column.
	SetIdentity	Sets this matrix to an identity matrix.
	SetRow	Sets a row.
	SetSubmatrix	Sets a submatrix of this matrix.
	SolveLinearEquations(MatrixF, MatrixF)	Solves the linear set of equations A * X = B.
	SolveLinearEquations(MatrixF, VectorF)	Solves the linear set of equations A * x = b.
	Subtract	Subtracts two matrices.
	ToArray1D	Converts this matrix to an array of float values.
	ToArray2D	Converts this MatrixF to a 2-dimensional float array.
	ToArrayJagged	Converts this MatrixF to a jagged float array.
	ToList	Converts this matrix to a list of float values.
	ToMatrix22F	Converts this MatrixF to Matrix22F.
	ToMatrix33F	Converts this MatrixF to Matrix33F.
	ToMatrix44F	Converts this MatrixF to Matrix44F.
	ToMatrixD	Converts this MatrixF to MatrixD.
	ToString	Returns the string representation of this matrix. (Overrides ObjectToString.)
	ToString(IFormatProvider)	Returns the string representation of this matrix using the specified culture-specific format information.
	Transpose	Transposes this matrix.
	TryInvert	Inverts the matrix if it is invertible.
	WriteXml	Converts an object into its XML representation.

Top

Operators

	Name	Description
	Addition	Adds two matrices.
	Division	Divides a matrix by a scalar.
	Equality	Tests if two matrices are equal.
	(MatrixF to Single)	Performs an explicit conversion from MatrixF to a 2-dimensional float array.
	(MatrixF to Single)	Performs an explicit conversion from MatrixF to jagged float array.
	(MatrixF to Matrix22F)	Performs an explicit conversion from MatrixF to Matrix22F.
	(MatrixF to Matrix33F)	Performs an explicit conversion from MatrixF to Matrix33F.
	(MatrixF to Matrix44F)	Performs an explicit conversion from MatrixF to Matrix44F.
	(MatrixF to MatrixD)	Performs an implicit conversion from MatrixF to MatrixD.
	Inequality	Tests if two matrices are not equal.
	Multiply(Single, MatrixF)	Multiplies a matrix by a scalar.
	Multiply(MatrixF, MatrixF)	Multiplies two matrices.
	Multiply(MatrixF, VectorF)	Multiplies a matrix with a column vector.
	Multiply(MatrixF, Single)	Multiplies a matrix and a scalar.
	Subtraction	Subtracts two matrices.
	UnaryNegation	Negates a matrix.

Top

Properties

	Name	Description
	Determinant	Returns the determinant of this matrix.
	Inverse	Returns the inverse or pseudo-inverse of this matrix.
	IsNaN	Gets a value indicating whether a component of the vector is NaN.
	IsSquare	Gets a value indicating whether this matrix is a square matrix (number of rows is equal to number of columns).
	IsSymmetric	Gets a value indicating whether this matrix is symmetric.
	ItemInt32	Gets or sets the element at the specified index.
	ItemInt32, Int32	Gets or sets the element at the specified index.
	Norm1	Gets the one norm of this matrix.
	NormFrobenius	Gets the Frobenius norm of this matrix.
	NormInfinity	Gets the infinity norm of this matrix.
	NumberOfColumns	Gets the number of columns n.
	NumberOfRows	Gets the number of rows m.
	Trace	Gets the matrix trace (the sum of the diagonal elements).
	Transposed	Returns the transposed of this matrix.

Top

Remarks

All indices are zero-based. The first index is the row, the second is the column:

Copy

[0,0] [0,1] [0,2] ...
[1,0] [1,1] [1,2] ...
[2,0] [2,1] [2,2] ...
...   ...   ...   ...

Reference

DigitalRune.Mathematics.Algebra Namespace