#include <matrix2f.h>

Public Types
typedef float	ScalarType

Public Member Functions
	GfMatrix2f ()=default
	Default constructor. Leaves the matrix component values undefined. More...

	GfMatrix2f (float m00, float m01, float m10, float m11)

	GfMatrix2f (const float m[2][2])

	GfMatrix2f (float s)

	GfMatrix2f (int s)

	GfMatrix2f (const GfVec2f &v)

GF_API	GfMatrix2f (const std::vector< std::vector< double > > &v)

GF_API	GfMatrix2f (const std::vector< std::vector< float > > &v)

GF_API	GfMatrix2f (const class GfMatrix2d &m)
	This explicit constructor converts a "double" matrix to a "float" matrix. More...

void	SetRow (int i, const GfVec2f &v)
	Sets a row of the matrix from a Vec2. More...

void	SetColumn (int i, const GfVec2f &v)
	Sets a column of the matrix from a Vec2. More...

GfVec2f	GetRow (int i) const
	Gets a row of the matrix as a Vec2. More...

GfVec2f	GetColumn (int i) const
	Gets a column of the matrix as a Vec2. More...

GfMatrix2f &	Set (float m00, float m01, float m10, float m11)

GfMatrix2f &	Set (const float m[2][2])

GfMatrix2f &	SetIdentity ()
	Sets the matrix to the identity matrix. More...

GfMatrix2f &	SetZero ()
	Sets the matrix to zero. More...

GF_API GfMatrix2f &	SetDiagonal (float s)
	Sets the matrix to s times the identity matrix. More...

GF_API GfMatrix2f &	SetDiagonal (const GfVec2f &)
	Sets the matrix to have diagonal (`v[0], v[1]`). More...

GF_API float *	Get (float m[2][2]) const

float *	data ()

const float *	data () const

float *	GetArray ()
	Returns vector components as an array of `float` values. More...

const float *	GetArray () const
	Returns vector components as a const array of `float` values. More...

float *	operator[] (int i)

const float *	operator[] (int i) const

GF_API bool	operator== (const GfMatrix2d &m) const

GF_API bool	operator== (const GfMatrix2f &m) const

bool	operator!= (const GfMatrix2d &m) const

bool	operator!= (const GfMatrix2f &m) const

GF_API GfMatrix2f	GetTranspose () const
	Returns the transpose of the matrix. More...

GF_API GfMatrix2f	GetInverse (double *det=NULL, double eps=0) const

GF_API double	GetDeterminant () const
	Returns the determinant of the matrix. More...

GF_API GfMatrix2f &	operator*= (const GfMatrix2f &m)
	Post-multiplies matrix m into this matrix. More...

GF_API GfMatrix2f &	operator*= (double)
	Multiplies the matrix by a float. More...

GF_API GfMatrix2f &	operator+= (const GfMatrix2f &m)
	Adds matrix m to this matrix. More...

GF_API GfMatrix2f &	operator-= (const GfMatrix2f &m)
	Subtracts matrix m from this matrix. More...

Static Public Attributes
static const size_t	numRows = 2

static const size_t	numColumns = 2

Friends
class	GfMatrix2d

size_t	hash_value (GfMatrix2f const &m)
	Hash. More...

GfMatrix2f	operator* (const GfMatrix2f &m1, double d)
	Returns the product of a matrix and a float. More...

GfMatrix2f	operator* (double d, const GfMatrix2f &m)

GF_API friend GfMatrix2f	operator- (const GfMatrix2f &m)
	Returns the unary negation of matrix m. More...

GfMatrix2f	operator+ (const GfMatrix2f &m1, const GfMatrix2f &m2)
	Adds matrix m2 to m1. More...

GfMatrix2f	operator- (const GfMatrix2f &m1, const GfMatrix2f &m2)
	Subtracts matrix m2 from m1. More...

GfMatrix2f	operator* (const GfMatrix2f &m1, const GfMatrix2f &m2)
	Multiplies matrix m1 by m2. More...

GfMatrix2f	operator/ (const GfMatrix2f &m1, const GfMatrix2f &m2)
	Divides matrix m1 by m2 (that is, `m1 * inv(m2)`). More...

GfVec2f	operator* (const GfMatrix2f &m, const GfVec2f &vec)
	Returns the product of a matrix m and a column vector vec. More...

GfVec2f	operator* (const GfVec2f &vec, const GfMatrix2f &m)
	Returns the product of row vector vec and a matrix m. More...

Detailed Description

Stores a 2x2 matrix of float elements. A basic type.

Matrices are defined to be in row-major order, so matrix[i][j] indexes the element in the i th row and the j th column.

Definition at line 61 of file matrix2f.h.

Member Typedef Documentation

typedef float GfMatrix2f::ScalarType

Definition at line 64 of file matrix2f.h.

Constructor & Destructor Documentation

GfMatrix2f::GfMatrix2f ( )

default

Default constructor. Leaves the matrix component values undefined.

GfMatrix2f::GfMatrix2f	(	float	m00,
		float	m01,
		float	m10,
		float	m11
	)

inline

Constructor. Initializes the matrix from 4 independent float values, specified in row-major order. For example, parameter m10 specifies the value in row 1 and column 0.

Definition at line 75 of file matrix2f.h.

GfMatrix2f::GfMatrix2f ( const float m[2][2] )

inline

Constructor. Initializes the matrix from a 2x2 array of float values, specified in row-major order.

Definition at line 83 of file matrix2f.h.

GfMatrix2f::GfMatrix2f ( float s )

inlineexplicit

Constructor. Explicitly initializes the matrix to s times the identity matrix.

Definition at line 89 of file matrix2f.h.

GfMatrix2f::GfMatrix2f ( int s )

inlineexplicit

This explicit constructor initializes the matrix to s times the identity matrix.

Definition at line 95 of file matrix2f.h.

GfMatrix2f::GfMatrix2f ( const GfVec2f & v )

inlineexplicit

Constructor. Explicitly initializes the matrix to diagonal form, with the i th element on the diagonal set to v[i].

Definition at line 101 of file matrix2f.h.

GF_API GfMatrix2f::GfMatrix2f ( const std::vector< std::vector< double > > & v )

explicit

Constructor. Initialize the matrix from a vector of vectors of double. The vector is expected to be 2x2. If it is too big, only the first 2 rows and/or columns will be used. If it is too small, uninitialized elements will be filled in with the corresponding elements from an identity matrix.

GF_API GfMatrix2f::GfMatrix2f ( const std::vector< std::vector< float > > & v )

explicit

Constructor. Initialize the matrix from a vector of vectors of float. The vector is expected to be 2x2. If it is too big, only the first 2 rows and/or columns will be used. If it is too small, uninitialized elements will be filled in with the corresponding elements from an identity matrix.

GF_API GfMatrix2f::GfMatrix2f ( const class GfMatrix2d & m )

explicit

This explicit constructor converts a "double" matrix to a "float" matrix.

Member Function Documentation

float* GfMatrix2f::data ( )

inline

Returns raw access to components of matrix as an array of float values. Components are in row-major order.

Definition at line 194 of file matrix2f.h.

const float* GfMatrix2f::data ( ) const

inline

Returns const raw access to components of matrix as an array of float values. Components are in row-major order.

Definition at line 200 of file matrix2f.h.

GF_API float* GfMatrix2f::Get ( float m[2][2] ) const

Fills a 2x2 array of float values with the values in the matrix, specified in row-major order.

float* GfMatrix2f::GetArray ( )

inline

Returns vector components as an array of float values.

Definition at line 205 of file matrix2f.h.

const float* GfMatrix2f::GetArray ( ) const

inline

Returns vector components as a const array of float values.

Definition at line 210 of file matrix2f.h.

GfVec2f GfMatrix2f::GetColumn ( int i ) const

inline

Gets a column of the matrix as a Vec2.

Definition at line 145 of file matrix2f.h.

GF_API double GfMatrix2f::GetDeterminant ( ) const

Returns the determinant of the matrix.

GF_API GfMatrix2f GfMatrix2f::GetInverse	(	double *	det = `NULL`,
		double	eps = `0`
	)		const

Returns the inverse of the matrix, or FLT_MAX * SetIdentity() if the matrix is singular. (FLT_MAX is the largest value a float can have, as defined by the system.) The matrix is considered singular if the determinant is less than or equal to the optional parameter eps. If det is non-null, *det is set to the determinant.

GfVec2f GfMatrix2f::GetRow ( int i ) const

inline

Gets a row of the matrix as a Vec2.

Definition at line 140 of file matrix2f.h.

GF_API GfMatrix2f GfMatrix2f::GetTranspose ( ) const

Returns the transpose of the matrix.

bool GfMatrix2f::operator!= ( const GfMatrix2d & m ) const

inline

Tests for element-wise matrix inequality. All elements must match exactly for matrices to be considered equal.

Definition at line 246 of file matrix2f.h.

bool GfMatrix2f::operator!= ( const GfMatrix2f & m ) const

inline

Tests for element-wise matrix inequality. All elements must match exactly for matrices to be considered equal.

Definition at line 252 of file matrix2f.h.

GF_API GfMatrix2f& GfMatrix2f::operator*= ( const GfMatrix2f & m )

Post-multiplies matrix m into this matrix.

GF_API GfMatrix2f& GfMatrix2f::operator*= ( double )

Multiplies the matrix by a float.

GF_API GfMatrix2f& GfMatrix2f::operator+= ( const GfMatrix2f & m )

Adds matrix m to this matrix.

GF_API GfMatrix2f& GfMatrix2f::operator-= ( const GfMatrix2f & m )

Subtracts matrix m from this matrix.

GF_API bool GfMatrix2f::operator== ( const GfMatrix2d & m ) const

Tests for element-wise matrix equality. All elements must match exactly for matrices to be considered equal.

GF_API bool GfMatrix2f::operator== ( const GfMatrix2f & m ) const

Tests for element-wise matrix equality. All elements must match exactly for matrices to be considered equal.

float* GfMatrix2f::operator[] ( int i )

inline

Accesses an indexed row i of the matrix as an array of 2 float values so that standard indexing (such as m[0][1]) works correctly.

Definition at line 217 of file matrix2f.h.

const float* GfMatrix2f::operator[] ( int i ) const

inline

Accesses an indexed row i of the matrix as an array of 2 float values so that standard indexing (such as m[0][1]) works correctly.

Definition at line 222 of file matrix2f.h.

GfMatrix2f& GfMatrix2f::Set	(	float	m00,
		float	m01,
		float	m10,
		float	m11
	)

inline

Sets the matrix from 4 independent float values, specified in row-major order. For example, parameter m10 specifies the value in row 1 and column 0.

Definition at line 152 of file matrix2f.h.

GfMatrix2f& GfMatrix2f::Set ( const float m[2][2] )

inline

Sets the matrix from a 2x2 array of float values, specified in row-major order.

Definition at line 161 of file matrix2f.h.

void GfMatrix2f::SetColumn	(	int	i,
		const GfVec2f &	v
	)

inline

Sets a column of the matrix from a Vec2.

Definition at line 134 of file matrix2f.h.

GF_API GfMatrix2f& GfMatrix2f::SetDiagonal ( float s )

Sets the matrix to s times the identity matrix.

GF_API GfMatrix2f& GfMatrix2f::SetDiagonal ( const GfVec2f & )

Sets the matrix to have diagonal (v[0], v[1]).

GfMatrix2f& GfMatrix2f::SetIdentity ( )

inline

Sets the matrix to the identity matrix.

Definition at line 170 of file matrix2f.h.

void GfMatrix2f::SetRow	(	int	i,
		const GfVec2f &	v
	)

inline

Sets a row of the matrix from a Vec2.

Definition at line 128 of file matrix2f.h.

GfMatrix2f& GfMatrix2f::SetZero ( )

inline

Sets the matrix to zero.

Definition at line 175 of file matrix2f.h.

Friends And Related Function Documentation

friend class GfMatrix2d

friend

Definition at line 355 of file matrix2f.h.

size_t hash_value ( GfMatrix2f const & m )

friend

Hash.

Definition at line 225 of file matrix2f.h.

GfMatrix2f operator*	(	const GfMatrix2f &	m1,
		double	d
	)

friend

Returns the product of a matrix and a float.

Definition at line 282 of file matrix2f.h.

GfMatrix2f operator*	(	double	d,
		const GfMatrix2f &	m
	)

friend

Definition at line 290 of file matrix2f.h.

GfMatrix2f operator*	(	const GfMatrix2f &	m1,
		const GfMatrix2f &	m2
	)

friend

Multiplies matrix m1 by m2.

Definition at line 324 of file matrix2f.h.

GfVec2f operator*	(	const GfMatrix2f &	m,
		const GfVec2f &	vec
	)

friend

Returns the product of a matrix m and a column vector vec.

Definition at line 338 of file matrix2f.h.

GfVec2f operator*	(	const GfVec2f &	vec,
		const GfMatrix2f &	m
	)

friend

Returns the product of row vector vec and a matrix m.

Definition at line 344 of file matrix2f.h.

GfMatrix2f operator+	(	const GfMatrix2f &	m1,
		const GfMatrix2f &	m2
	)

friend

Adds matrix m2 to m1.

Definition at line 308 of file matrix2f.h.

GF_API friend GfMatrix2f operator- ( const GfMatrix2f & m )

friend

Returns the unary negation of matrix m.

GfMatrix2f operator-	(	const GfMatrix2f &	m1,
		const GfMatrix2f &	m2
	)

friend

Subtracts matrix m2 from m1.

Definition at line 316 of file matrix2f.h.

GfMatrix2f operator/	(	const GfMatrix2f &	m1,
		const GfMatrix2f &	m2
	)

friend

Divides matrix m1 by m2 (that is, m1 * inv(m2)).

Definition at line 332 of file matrix2f.h.

Member Data Documentation

const size_t GfMatrix2f::numColumns = 2

static

Definition at line 67 of file matrix2f.h.

const size_t GfMatrix2f::numRows = 2

static

Definition at line 66 of file matrix2f.h.

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

pxr/base/gf/matrix2f.h

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation