Struct Matrix2d

Represents a 2x2 matrix

Implements

IEquatable<Matrix2d>

Inherited Members

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: OpenTK

Assembly: OpenTK.dll

Syntax

public struct Matrix2d : IEquatable<Matrix2d>

Constructors

Matrix2d(Vector2d, Vector2d)

Constructs a new instance.

Declaration

public Matrix2d(Vector2d row0, Vector2d row1)

Parameters

Type	Name	Description
Vector2d	row0	Top row of the matrix.
Vector2d	row1	Bottom row of the matrix.

Matrix2d(Double, Double, Double, Double)

Constructs a new instance

Declaration

public Matrix2d(double m00, double m01, double m10, double m11)

Parameters

Type	Name	Description
Double	m00	First item of the first row of the matrix.
Double	m01	Second item of the first row of the matrix.
Double	m10	First item of the second row of the matrix.
Double	m11	Second item of the second row of the matrix.

Fields

Identity

The identity matrix.

Declaration

public static readonly Matrix2d Identity

Field Value

Type	Description
Matrix2d

Row0

Top row of the matrix.

Declaration

public Vector2d Row0

Field Value

Type	Description
Vector2d

Row1

Bottom row of the matrix.

Declaration

public Vector2d Row1

Field Value

Type	Description
Vector2d

Zero

The zero matrix.

Declaration

public static readonly Matrix2d Zero

Field Value

Type	Description
Matrix2d

Properties

Column0

Gets or sets the first column of this matrix.

Declaration

public Vector2d Column0 { get; set; }

Property Value

Type	Description
Vector2d

Column1

Gets or sets the second column of this matrix.

Declaration

public Vector2d Column1 { get; set; }

Property Value

Type	Description
Vector2d

Determinant

Gets the determinant of this matrix.

Declaration

public readonly double Determinant { get; }

Property Value

Type	Description
Double

Diagonal

Gets or sets the values along the main diagonal of the matrix.

Declaration

public Vector2d Diagonal { get; set; }

Property Value

Type	Description
Vector2d

Item[Int32, Int32]

Gets or sets the value at a specified row and column.

Declaration

public double this[int rowIndex, int columnIndex] { get; set; }

Parameters

Type	Name	Description
Int32	rowIndex
Int32	columnIndex

Property Value

Type	Description
Double

M11

Gets or sets the value at row 1, column 1 of this instance.

Declaration

public double M11 { get; set; }

Property Value

Type	Description
Double

M12

Gets or sets the value at row 1, column 2 of this instance.

Declaration

public double M12 { get; set; }

Property Value

Type	Description
Double

M21

Gets or sets the value at row 2, column 1 of this instance.

Declaration

public double M21 { get; set; }

Property Value

Type	Description
Double

M22

Gets or sets the value at row 2, column 2 of this instance.

Declaration

public double M22 { get; set; }

Property Value

Type	Description
Double

Trace

Gets the trace of the matrix, the sum of the values along the diagonal.

Declaration

public readonly double Trace { get; }

Property Value

Type	Description
Double

Methods

Add(Matrix2d, Matrix2d)

Adds two instances.

Declaration

public static Matrix2d Add(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the addition.
Matrix2d	right	The right operand of the addition.

Returns

Type	Description
Matrix2d	A new instance that is the result of the addition.

Add(ref Matrix2d, ref Matrix2d, out Matrix2d)

Adds two instances.

Declaration

public static void Add(ref Matrix2d left, ref Matrix2d right, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the addition.
Matrix2d	right	The right operand of the addition.
Matrix2d	result	A new instance that is the result of the addition.

CreateRotation(Double)

Builds a rotation matrix.

Declaration

public static Matrix2d CreateRotation(double angle)

Parameters

Type	Name	Description
Double	angle	The counter-clockwise angle in radians.

Returns

Type	Description
Matrix2d	The resulting Matrix2d instance.

CreateRotation(Double, out Matrix2d)

Builds a rotation matrix.

Declaration

public static void CreateRotation(double angle, out Matrix2d result)

Parameters

Type	Name	Description
Double	angle	The counter-clockwise angle in radians.
Matrix2d	result	The resulting Matrix2d instance.

CreateScale(Vector2d)

Creates a scale matrix.

Declaration

public static Matrix2d CreateScale(Vector2d scale)

Parameters

Type	Name	Description
Vector2d	scale	Scale factors for the x and y axes.

Returns

Type	Description
Matrix2d	A scale matrix.

CreateScale(Vector2d, out Matrix2d)

Creates a scale matrix.

Declaration

public static void CreateScale(Vector2d scale, out Matrix2d result)

Parameters

Type	Name	Description
Vector2d	scale	Scale factors for the x and y axes.
Matrix2d	result	A scale matrix.

CreateScale(Double)

Creates a scale matrix.

Declaration

public static Matrix2d CreateScale(double scale)

Parameters

Type	Name	Description
Double	scale	Single scale factor for the x and y axes.

Returns

Type	Description
Matrix2d	A scale matrix.

CreateScale(Double, out Matrix2d)

Creates a scale matrix.

Declaration

public static void CreateScale(double scale, out Matrix2d result)

Parameters

Type	Name	Description
Double	scale	Single scale factor for the x, y, and z axes.
Matrix2d	result	A scale matrix.

CreateScale(Double, Double)

Creates a scale matrix.

Declaration

public static Matrix2d CreateScale(double x, double y)

Parameters

Type	Name	Description
Double	x	Scale factor for the x axis.
Double	y	Scale factor for the y axis.

Returns

Type	Description
Matrix2d	A scale matrix.

CreateScale(Double, Double, out Matrix2d)

Creates a scale matrix.

Declaration

public static void CreateScale(double x, double y, out Matrix2d result)

Parameters

Type	Name	Description
Double	x	Scale factor for the x axis.
Double	y	Scale factor for the y axis.
Matrix2d	result	A scale matrix.

Equals(Matrix2d)

Indicates whether the current matrix is equal to another matrix.

Declaration

public bool Equals(Matrix2d other)

Parameters

Type	Name	Description
Matrix2d	other	An matrix to compare with this matrix.

Returns

Type	Description
Boolean	true if the current matrix is equal to the matrix parameter; otherwise, false.

Equals(Object)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare to.

Returns

Type	Description
Boolean	True if the instances are equal; false otherwise.

Overrides

ValueType.Equals(Object)

GetHashCode()

Returns the hashcode for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A System.Int32 containing the unique hashcode for this instance.

Overrides

ValueType.GetHashCode()

Invert()

Converts this instance into its inverse.

Declaration

public void Invert()

Invert(Matrix2d)

Calculate the inverse of the given matrix

Declaration

public static Matrix2d Invert(Matrix2d mat)

Parameters

Type	Name	Description
Matrix2d	mat	The matrix to invert

Returns

Type	Description
Matrix2d	The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix2d is singular.

Invert(ref Matrix2d, out Matrix2d)

Calculate the inverse of the given matrix

Declaration

public static void Invert(ref Matrix2d mat, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	mat	The matrix to invert
Matrix2d	result	The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

Type	Condition
InvalidOperationException	Thrown if the Matrix2d is singular.

Mult(Matrix2d, Matrix2d)

Multiplies two instances.

Declaration

public static Matrix2d Mult(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2d	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2d	A new instance that is the result of the multiplication.

Mult(Matrix2d, Matrix2x3d)

Multiplies two instances.

Declaration

public static Matrix2x3d Mult(Matrix2d left, Matrix2x3d right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2x3d	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2x3d	A new instance that is the result of the multiplication.

Mult(Matrix2d, Matrix2x4d)

Multiplies two instances.

Declaration

public static Matrix2x4d Mult(Matrix2d left, Matrix2x4d right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2x4d	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2x4d	A new instance that is the result of the multiplication.

Mult(Matrix2d, Double)

Multiplies and instance by a scalar.

Declaration

public static Matrix2d Mult(Matrix2d left, double right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Double	right	The right operand of the multiplication.

Returns

Type	Description
Matrix2d	A new instance that is the result of the multiplication.

Mult(ref Matrix2d, ref Matrix2d, out Matrix2d)

Multiplies two instances.

Declaration

public static void Mult(ref Matrix2d left, ref Matrix2d right, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2d	right	The right operand of the multiplication.
Matrix2d	result	A new instance that is the result of the multiplication.

Mult(ref Matrix2d, ref Matrix2x3d, out Matrix2x3d)

Multiplies two instances.

Declaration

public static void Mult(ref Matrix2d left, ref Matrix2x3d right, out Matrix2x3d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2x3d	right	The right operand of the multiplication.
Matrix2x3d	result	A new instance that is the result of the multiplication.

Mult(ref Matrix2d, ref Matrix2x4d, out Matrix2x4d)

Multiplies two instances.

Declaration

public static void Mult(ref Matrix2d left, ref Matrix2x4d right, out Matrix2x4d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Matrix2x4d	right	The right operand of the multiplication.
Matrix2x4d	result	A new instance that is the result of the multiplication.

Mult(ref Matrix2d, Double, out Matrix2d)

Multiplies and instance by a scalar.

Declaration

public static void Mult(ref Matrix2d left, double right, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the multiplication.
Double	right	The right operand of the multiplication.
Matrix2d	result	A new instance that is the result of the multiplication.

Subtract(Matrix2d, Matrix2d)

Subtracts two instances.

Declaration

public static Matrix2d Subtract(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the subtraction.
Matrix2d	right	The right operand of the subtraction.

Returns

Type	Description
Matrix2d	A new instance that is the result of the subtraction.

Subtract(ref Matrix2d, ref Matrix2d, out Matrix2d)

Subtracts two instances.

Declaration

public static void Subtract(ref Matrix2d left, ref Matrix2d right, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	left	The left operand of the subtraction.
Matrix2d	right	The right operand of the subtraction.
Matrix2d	result	A new instance that is the result of the subtraction.

ToString()

Returns a System.String that represents the current Matrix4.

Declaration

public override string ToString()

Returns

Type	Description
String	The string representation of the matrix.

Overrides

ValueType.ToString()

Transpose()

Converts this instance to it's transpose.

Declaration

public void Transpose()

Transpose(Matrix2d)

Calculate the transpose of the given matrix.

Declaration

public static Matrix2d Transpose(Matrix2d mat)

Parameters

Type	Name	Description
Matrix2d	mat	The matrix to transpose.

Returns

Type	Description
Matrix2d	The transpose of the given matrix.

Transpose(ref Matrix2d, out Matrix2d)

Calculate the transpose of the given matrix.

Declaration

public static void Transpose(ref Matrix2d mat, out Matrix2d result)

Parameters

Type	Name	Description
Matrix2d	mat	The matrix to transpose.
Matrix2d	result	The transpose of the given matrix.

Operators

Addition(Matrix2d, Matrix2d)

Matrix addition

Declaration

public static Matrix2d operator +(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Matrix2d	right	right-hand operand

Returns

Type	Description
Matrix2d	A new Matrix2d which holds the result of the addition

Equality(Matrix2d, Matrix2d)

Compares two instances for equality.

Declaration

public static bool operator ==(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	The first instance.
Matrix2d	right	The second instance.

Returns

Type	Description
Boolean	True, if left equals right; false otherwise.

Inequality(Matrix2d, Matrix2d)

Compares two instances for inequality.

Declaration

public static bool operator !=(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	The first instance.
Matrix2d	right	The second instance.

Returns

Type	Description
Boolean	True, if left does not equal right; false otherwise.

Multiply(Matrix2d, Matrix2d)

Matrix multiplication

Declaration

public static Matrix2d operator *(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Matrix2d	right	right-hand operand

Returns

Type	Description
Matrix2d	A new Matrix2d which holds the result of the multiplication

Multiply(Matrix2d, Matrix2x3d)

Matrix multiplication

Declaration

public static Matrix2x3d operator *(Matrix2d left, Matrix2x3d right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Matrix2x3d	right	right-hand operand

Returns

Type	Description
Matrix2x3d	A new Matrix2x3d which holds the result of the multiplication

Multiply(Matrix2d, Matrix2x4d)

Matrix multiplication

Declaration

public static Matrix2x4d operator *(Matrix2d left, Matrix2x4d right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Matrix2x4d	right	right-hand operand

Returns

Type	Description
Matrix2x4d	A new Matrix2x4d which holds the result of the multiplication

Multiply(Matrix2d, Double)

Scalar multiplication.

Declaration

public static Matrix2d operator *(Matrix2d left, double right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Double	right	right-hand operand

Returns

Type	Description
Matrix2d	A new Matrix2d which holds the result of the multiplication

Multiply(Double, Matrix2d)

Scalar multiplication.

Declaration

public static Matrix2d operator *(double left, Matrix2d right)

Parameters

Type	Name	Description
Double	left	left-hand operand
Matrix2d	right	right-hand operand

Returns

Type	Description
Matrix2d	A new Matrix2d which holds the result of the multiplication

Subtraction(Matrix2d, Matrix2d)

Matrix subtraction

Declaration

public static Matrix2d operator -(Matrix2d left, Matrix2d right)

Parameters

Type	Name	Description
Matrix2d	left	left-hand operand
Matrix2d	right	right-hand operand

Returns

Type	Description
Matrix2d	A new Matrix2d which holds the result of the subtraction

Implements

System.IEquatable<T>