Represents a mathematical 3x3 matrix with an underlying data type of float. More...

Public Member Functions
override string	ToString ()

	mat3f (float initialValue)
	Creates a new `mat3f` with all elements initalized to the value provided. More...

	mat3f (float e00, float e01, float e02, float e10, float e11, float e12, float e20, float e21, float e22)
	Creates a new `mat3f` with its elements intialized to the provided values. More...

	mat3f (IEnumerable< float > colMajorOrderedElements)
	Constructs a new `mat3f` from the provided elements. More...

mat3f	Negate ()
	Negates `this mat3f`. More...

mat3f	Multiply (float scalar)
	Multiplies `this mat3f` by the provided `scalar` value and returns the result. More...

mat3f	Multiply (mat3f rhs)
	Multiplies `this mat3f` by the provided right-side `mat3f`. More...

mat3f	Divide (float scalar)
	Divides `this mat3f` by the provided `scalar` value and returns the result. More...

mat3f	Add (mat3f matrix)
	Adds `this Matrix3F` with the provided `mat3f` together. More...

mat3f	Subtract (mat3f rhs)
	Subtracts the provided `mat3f` from `this mat3f`. More...

mat3f	Transpose ()
	Computes the transpose of `this mat3f`. More...

float[]	ToArray ()
	Returns an array of `this mat3f` in column-major ordering. More...

float[]	ToArray (bool columnMajorOrdering)
	Returns an array of `this mat3f` in column-major ordering by default. More...

Static Public Member Functions
static mat3f	operator* (mat3f lhs, float rhs)
	Operator overloaded version of `mat3f.Multiply` method. More...

static mat3f	operator* (float lhs, mat3f rhs)
	Operator overloaded version of `mat3f.Multiply` method. More...

static mat3f	operator* (mat3f lhs, mat3f rhs)
	Operator overloaded version of `mat3f.Multiply` method. More...

static mat3f	operator/ (mat3f lhs, float rhs)
	Operator overloaded version of `mat3f.Divide` method. More...

static mat3f	operator+ (mat3f lhs, mat3f rhs)
	Operator overloaded version of `mat3f.Add` method. More...

static mat3f	operator- (mat3f lhs, mat3f rhs)
	Operator overloaded version of `mat3f.Subtract` method. More...

static mat3f	operator- (mat3f value)
	Operator overloaded version of `mat3f.Negate` method. More...

Public Attributes
float	E00
	The element located at row 0 and column 0. More...

float	E10
	The element located at row 1 and column 0. More...

float	E20
	The element located at row 2 and column 0. More...

float	E01
	The element located at row 0 and column 1. More...

float	E11
	The element located at row 1 and column 1. More...

float	E21
	The element located at row 2 and column 1. More...

float	E02
	The element located at row 0 and column 2. More...

float	E12
	The element located at row 1 and column 2. More...

float	E22
	The element located at row 2 and column 2. More...

Properties
int	RowDimension `[get]`
	The dimension of the `Matrix3F`'s rows. More...

int	ColumnDimension `[get]`
	The dimension of the `Matrix3F`'s columns. More...

static mat3f	Zero `[get]`
	Returns a new `mat3f` with all of its elements initialized to 0. More...

static mat3f	One `[get]`
	Returns a new `mat3f` with all of its components initialized to 1. More...

static mat3f	Identity `[get]`
	Returns a new `mat3f` with diagonal elements set to 1 and the off-diagonal elements set to 0. More...

float	this[int row, int col] `[get, set]`
	Returns the element of the `mat3f` stored at the provided `row` and `col` using zero-based indexing. More...

Detailed Description

Represents a mathematical 3x3 matrix with an underlying data type of float.

Constructor & Destructor Documentation

VectorNav.Math.mat3f.mat3f ( float initialValue )

Creates a new mat3f with all elements initalized to the value provided.

Parameters

initialValue The to intialize the elements of the mat3f to.

VectorNav.Math.mat3f.mat3f	(	float	e00,
		float	e01,
		float	e02,
		float	e10,
		float	e11,
		float	e12,
		float	e20,
		float	e21,
		float	e22
	)

Creates a new mat3f with its elements intialized to the provided values.

Parameters

e00	Value for the element located at row 0, column 0.
e01	Value for the element located at row 0, column 1.
e02	Value for the element located at row 0, column 2.
e10	Value for the element located at row 1, column 0.
e11	Value for the element located at row 1, column 1.
e12	Value for the element located at row 1, column 2.
e20	Value for the element located at row 2, column 0.
e21	Value for the element located at row 2, column 1.
e22	Value for the element located at row 2, column 2.

VectorNav.Math.mat3f.mat3f ( IEnumerable< float > colMajorOrderedElements )

Constructs a new mat3f from the provided elements.

Parameters

colMajorOrderedElements The elements in column-major ordering.

Exceptions

ArgumentException The number of flattened elements was not of length 9.

Member Function Documentation

mat3f VectorNav.Math.mat3f.Add ( mat3f matrix )

Adds this Matrix3F with the provided mat3f together.

Parameters

matrix The mat3f to add to this mat3f.

Returns: The resultant mat3f from the addition.

mat3f VectorNav.Math.mat3f.Divide ( float scalar )

Divides this mat3f by the provided scalar value and returns the result.

Parameters

scalar The scalar value to divide this mat3f by.

Returns: The resulting mat3f.

Exceptions

DivideByZeroException The provided scalar had a value of zero.

mat3f VectorNav.Math.mat3f.Multiply ( float scalar )

Multiplies this mat3f by the provided scalar value and returns the result.

Parameters

scalar The scalar value to multiply this mat3f by.

Returns: The resulting mat3f.

mat3f VectorNav.Math.mat3f.Multiply ( mat3f rhs )

Multiplies this mat3f by the provided right-side mat3f.

Parameters

rhs	The right-side `mat3f`.

Returns: The resulting matrix.

mat3f VectorNav.Math.mat3f.Negate ( )

Negates this mat3f.

Returns: The negated mat3f.

static mat3f VectorNav.Math.mat3f.operator*	(	mat3f	lhs,
		float	rhs
	)

static

Operator overloaded version of mat3f.Multiply method.

Parameters

lhs	The left-side `mat3f` of the multiplication symbol.
rhs	The right-side scalar of the multiplication symbol.

Returns: The mat3f resulting from the operation.

static mat3f VectorNav.Math.mat3f.operator*	(	float	lhs,
		mat3f	rhs
	)

static

Operator overloaded version of mat3f.Multiply method.

Parameters

lhs	The left-side scalar of the multiplication symbol.
rhs	The right-side `mat3f` of the multiplication symbol.

Returns: The mat3f resulting from the operation.

static mat3f VectorNav.Math.mat3f.operator*	(	mat3f	lhs,
		mat3f	rhs
	)

static

Operator overloaded version of mat3f.Multiply method.

Parameters

lhs	The left-side `mat3f` of the multiplication symbol.
rhs	The right-side `mat3f` of the multiplication symbol.

Returns: The mat3f resulting from the operation.

static mat3f VectorNav.Math.mat3f.operator+	(	mat3f	lhs,
		mat3f	rhs
	)

static

Operator overloaded version of mat3f.Add method.

Parameters

lhs	The left-side `mat3f` of the addition symbol.
rhs	The right-side `mat3f` of the addition symbol.

Returns: The mat3f resulting from the operation.

static mat3f VectorNav.Math.mat3f.operator-	(	mat3f	lhs,
		mat3f	rhs
	)

static

Operator overloaded version of mat3f.Subtract method.

Parameters

lhs	The left-side `mat3f` of the subtraction symbol.
rhs	The right-side `mat3f` of the subtraction symbol.

Returns: The mat3f resulting from the operation.

static mat3f VectorNav.Math.mat3f.operator- ( mat3f value )

static

Operator overloaded version of mat3f.Negate method.

Parameters

value The mat3f to negate.

Returns: The negated mat3f.

static mat3f VectorNav.Math.mat3f.operator/	(	mat3f	lhs,
		float	rhs
	)

static

Operator overloaded version of mat3f.Divide method.

Parameters

lhs	The left-side `mat3f` of the division symbol.
rhs	The right-side scalar of the division symbol.

Returns: The mat3f resulting from the operation.

mat3f VectorNav.Math.mat3f.Subtract ( mat3f rhs )

Subtracts the provided mat3f from this mat3f.

Parameters

rhs	The `mat3f` to subtract from `this mat3f`.

Returns: The resultant mat3f from the subtraction.

float [] VectorNav.Math.mat3f.ToArray ( )

Returns an array of this mat3f in column-major ordering.

Returns: The flattened array of this mat3f.

float [] VectorNav.Math.mat3f.ToArray ( bool columnMajorOrdering )

Returns an array of this mat3f in column-major ordering by default.

Parameters

columnMajorOrdering Indicates if the returned array should be in column-major or row-major ordering.

Returns: The flattened array of this mat3f.

mat3f VectorNav.Math.mat3f.Transpose ( )

Computes the transpose of this mat3f.

Returns: The transposed mat3f.

Member Data Documentation

float VectorNav.Math.mat3f.E00

The element located at row 0 and column 0.

float VectorNav.Math.mat3f.E01

The element located at row 0 and column 1.

float VectorNav.Math.mat3f.E02

The element located at row 0 and column 2.

float VectorNav.Math.mat3f.E10

The element located at row 1 and column 0.

float VectorNav.Math.mat3f.E11

The element located at row 1 and column 1.

float VectorNav.Math.mat3f.E12

The element located at row 1 and column 2.

float VectorNav.Math.mat3f.E20

The element located at row 2 and column 0.

float VectorNav.Math.mat3f.E21

The element located at row 2 and column 1.

float VectorNav.Math.mat3f.E22

The element located at row 2 and column 2.

Property Documentation

int VectorNav.Math.mat3f.ColumnDimension

get

The dimension of the Matrix3F's columns.

mat3f VectorNav.Math.mat3f.Identity

staticget

Returns a new mat3f with diagonal elements set to 1 and the off-diagonal elements set to 0.

mat3f VectorNav.Math.mat3f.One

staticget

Returns a new mat3f with all of its components initialized to 1.

int VectorNav.Math.mat3f.RowDimension

get

The dimension of the Matrix3F's rows.

float VectorNav.Math.mat3f.this[int row, int col]

getset

Returns the element of the mat3f stored at the provided row and col using zero-based indexing.

Parameters

row	The zero-based row index.
col	The zero-based column index.

Returns: The element stored at the requested index.

Exceptions

ArgumentException One of the indexes was either negative or exceeded either the row or the column dimension.

mat3f VectorNav.Math.mat3f.Zero

staticget

Returns a new mat3f with all of its elements initialized to 0.

The documentation for this struct was generated from the following file:

src/Math/mat3f.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation