Double precision 2x2 matrix class. More...

#include <cvb/matrix_2d.hpp>

Public Member Functions
	Matrix2D () noexcept=default
	Default constructor for empty matrix.

template<std::size_t N>
	Matrix2D (const double(&list)[N]) noexcept
	Construct a 2x2 matrix with an initializer list.

	Matrix2D (double a11, double a12, double a21, double a22) noexcept
	Construct a 2x2 matrix.

	Matrix2D (Angle rotation, double scale=1.0) noexcept
	Construct a 2x2 matrix that is a combination of a rotation and scale operation.

	Matrix2D (double scale) noexcept
	Construct a 2x2 matrix that represents a scaling.

	Matrix2D (double scaleX, double scaleY) noexcept
	Constructs a 2x2 matrix that represent a scaling with different scaling in x and y directions.

	Matrix2D (Cvb::Point2D< double > column1, Cvb::Point2D< double > column2) noexcept
	Construct a 2x2 matrix from two column vectors.

const double *	operator[] (int row) const noexcept
	Index based element access.

double *	operator[] (int row) noexcept
	Index based element access.

const double &	At (int row, int column) const noexcept
	Index based element access.

double &	At (int row, int column) noexcept
	Index based element access.

double	A11 () const noexcept
	Gets top left matrix element.

void	SetA11 (double a11) noexcept
	Sets top left matrix element.

double	A12 () const noexcept
	Gets top right matrix element.

void	SetA12 (double a12) noexcept
	Sets top right matrix element.

double	A21 () const noexcept
	Gets bottom left matrix element.

void	SetA21 (double a21) noexcept
	Sets bottom left matrix element.

double	A22 () const noexcept
	Gets bottom right matrix element.

void	SetA22 (double a22) noexcept
	Sets bottom right matrix element.

double	Det () const noexcept
	Matrix determinant.

void	Invert ()
	Inverts this matrix in-place if possible.

Matrix2D	Inverse ()
	Gets the inverse of this matrix if possible.

bool	operator== (const Matrix2D &matrix) const noexcept
	Compares to an other matrix.

bool	operator!= (const Matrix2D &matrix) const noexcept
	Compares to an other matrix.

Matrix2D &	operator+= (const Matrix2D &matrix) noexcept
	Adds and assigns to this matrix.

Matrix2D &	operator-= (const Matrix2D &matrix) noexcept
	Subtracts and assigns to this matrix.

Matrix2D &	operator*= (const Matrix2D &matrix) noexcept
	Multiplies and assigns to this matrix.

Matrix2D &	operator*= (const double &value) noexcept
	Multiplies and assigns to this matrix.

Matrix2D &	operator/= (const double &value) noexcept
	Divides each element of this matrix by the given value.

Static Public Member Functions
static Matrix2D	Identity () noexcept
	The identity element.

Related Symbols
(Note that these are not member symbols.)
Matrix2D	operator+ (const Matrix2D &lhs, const Matrix2D &rhs)
	Add two matrices.

Matrix2D	operator- (const Matrix2D &lhs, const Matrix2D &rhs)
	Substract two matrices.

Matrix2D	operator* (const Matrix2D &lhs, const Matrix2D &rhs)
	Multiply two matrices.

Point2D< double >	operator* (const Matrix2D &lhs, const Point2D< double > &rhs)
	Multiply matrix with 2D point.

Matrix2D	operator* (const Matrix2D &lhs, const double &rhs)
	Multiply matrix with scalar.

Matrix2D	operator* (const double &lhs, const Matrix2D &rhs)
	Multiply scalar with matrix .

Matrix2D	operator/ (const Matrix2D &lhs, const double &rhs)
	Divide matrix by scalar.

Detailed Description

Double precision 2x2 matrix class.

Constructor & Destructor Documentation

◆ Matrix2D() [1/7]

Matrix2D ( )

defaultnoexcept

Default constructor for empty matrix.

Exceptions

Does	not throw any exception.

◆ Matrix2D() [2/7]

template<std::size_t N>

Matrix2D ( const double(&) list[N] )

inlinenoexcept

Construct a 2x2 matrix with an initializer list.

Parameters

[in] list Containing exactly 4 elements.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Matrix2D() [3/7]

Matrix2D	(	double	a11,
		double	a12,
		double	a21,
		double	a22 )

inlinenoexcept

Construct a 2x2 matrix.

Parameters

[in]	a11	Top left matrix element.
[in]	a12	Top right matrix element.
[in]	a21	Bottom left matrix element.
[in]	a22	Bottom right matrix element.

Exceptions

Does	not throw any exception.

◆ Matrix2D() [4/7]

Matrix2D	(	Angle	rotation,
		double	scale = 1.0 )

inlineexplicitnoexcept

Construct a 2x2 matrix that is a combination of a rotation and scale operation.

Parameters

[in]	rotation	Rotation angle to create the matrix for.
[in]	scale	Scale factor to create the matrix for.

Exceptions

Does	not throw any exception.

◆ Matrix2D() [5/7]

Matrix2D ( double scale )

inlineexplicitnoexcept

Construct a 2x2 matrix that represents a scaling.

Parameters

[in] scale Scale factor to create the matrix for.

Exceptions

Does	not throw any exception.

◆ Matrix2D() [6/7]

Matrix2D	(	double	scaleX,
		double	scaleY )

inlinenoexcept

Constructs a 2x2 matrix that represent a scaling with different scaling in x and y directions.

Parameters

[in]	scaleX	Scale factor in X direction to create the matrix.
[in]	scaleY	Scale factor in Y direction to create the matrix.

Exceptions

Does	not throw any exception.

◆ Matrix2D() [7/7]

Matrix2D	(	Cvb::Point2D< double >	column1,
		Cvb::Point2D< double >	column2 )

inlinenoexcept

Construct a 2x2 matrix from two column vectors.

Parameters

[in]	column1	Column vector one.
[in]	column2	Columns vector two.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ A11()

double A11 ( ) const

inlinenoexcept

Gets top left matrix element.

Returns: double The element.

Exceptions

Does	not throw any exception.

◆ A12()

double A12 ( ) const

inlinenoexcept

Gets top right matrix element.

Returns: double The element.

Exceptions

Does	not throw any exception.

◆ A21()

double A21 ( ) const

inlinenoexcept

Gets bottom left matrix element.

Returns: double The element.

Exceptions

Does	not throw any exception.

◆ A22()

double A22 ( ) const

inlinenoexcept

Gets bottom right matrix element.

Returns: double The element.

Exceptions

Does	not throw any exception.

◆ At() [1/2]

const double & At	(	int	row,
		int	column ) const

inlinenoexcept

Index based element access.

Parameters

[in]	row	The row to access.
[in]	column	The column to access.

Returns: The matrix element.

Exceptions

Does	not throw any exception.

◆ At() [2/2]

double & At	(	int	row,
		int	column )

inlinenoexcept

Index based element access.

Parameters

[in]	row	The row to access.
[in]	column	The column to access.

Returns: The matrix element.

Exceptions

Does	not throw any exception.

◆ Det()

double Det ( ) const

inlinenoexcept

Matrix determinant.

Returns: The determinant.

Exceptions

Does	not throw any exception.

◆ Identity()

static Matrix2D Identity ( )

inlinestaticnoexcept

The identity element.

Returns: An identity matrix.

Exceptions

Does	not throw any exception.

◆ Inverse()

Matrix2D Inverse ( )

inline

Gets the inverse of this matrix if possible.

Exceptions

Any	exception derived from std::exception including CvbException.

Returns: Inverse.

Might cause division by zero.

◆ Invert()

void Invert ( )

inline

Inverts this matrix in-place if possible.

Exceptions

Any	exception derived from std::exception including CvbException.

Might cause division by zero.

◆ operator!=()

bool operator!= ( const Matrix2D & matrix ) const

inlinenoexcept

Compares to an other matrix.

Parameters

[in] matrix Other matrix.

Returns: True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator*=() [1/2]

Matrix2D & operator*= ( const double & value )

inlinenoexcept

Multiplies and assigns to this matrix.

Parameters

[in] value Factor.

Returns: This matrix.

Exceptions

Does	not throw any exception.

◆ operator*=() [2/2]

Matrix2D & operator*= ( const Matrix2D & matrix )

inlinenoexcept

Multiplies and assigns to this matrix.

Parameters

[in] matrix Other matrix.

Returns: This matrix.

Exceptions

Does	not throw any exception.

◆ operator+=()

Matrix2D & operator+= ( const Matrix2D & matrix )

inlinenoexcept

Adds and assigns to this matrix.

Parameters

[in] matrix Other matrix.

Returns: This matrix.

Exceptions

Does	not throw any exception.

◆ operator-=()

Matrix2D & operator-= ( const Matrix2D & matrix )

inlinenoexcept

Subtracts and assigns to this matrix.

Parameters

[in] matrix Other matrix.

Returns: This matrix.

Exceptions

Does	not throw any exception.

◆ operator/=()

Matrix2D & operator/= ( const double & value )

inlinenoexcept

Divides each element of this matrix by the given value.

Parameters

[in] value Divisor.

Returns: This matrix.

Exceptions

Does	not throw any exception.

◆ operator==()

bool operator== ( const Matrix2D & matrix ) const

inlinenoexcept

Compares to an other matrix.

Parameters

[in] matrix Other matrix.

Returns: True if equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator[]() [1/2]

const double * operator[] ( int row ) const

inlinenoexcept

Index based element access.

Parameters

[in] row

Returns: A raw pointer to the row

Exceptions

Does	not throw any exception.

◆ operator[]() [2/2]

double * operator[] ( int row )

inlinenoexcept

Index based element access.

Parameters

[in] row

Returns: A raw pointer to the row

Exceptions

Does	not throw any exception.

◆ SetA11()

void SetA11 ( double a11 )

inlinenoexcept

Sets top left matrix element.

Parameters

[in] a11 The element.

Exceptions

Does	not throw any exception.

◆ SetA12()

void SetA12 ( double a12 )

inlinenoexcept

Sets top right matrix element.

Parameters

[in] a12 The element.

Exceptions

Does	not throw any exception.

◆ SetA21()

void SetA21 ( double a21 )

inlinenoexcept

Sets bottom left matrix element.

Parameters

[in] a21 The element.

Exceptions

Does	not throw any exception.

◆ SetA22()

void SetA22 ( double a22 )

inlinenoexcept

Sets bottom right matrix element.

Parameters

[in] a22 The element.

Exceptions

Does	not throw any exception.

Friends And Related Symbol Documentation

◆ operator*() [1/4]

Matrix2D operator*	(	const double &	lhs,
		const Matrix2D &	rhs )

Multiply scalar with matrix .

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [2/4]

Matrix2D operator*	(	const Matrix2D &	lhs,
		const double &	rhs )

Multiply matrix with scalar.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [3/4]

Matrix2D operator*	(	const Matrix2D &	lhs,
		const Matrix2D &	rhs )

Multiply two matrices.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [4/4]

Point2D< double > operator*	(	const Matrix2D &	lhs,
		const Point2D< double > &	rhs )

Multiply matrix with 2D point.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator+()

Matrix2D operator+	(	const Matrix2D &	lhs,
		const Matrix2D &	rhs )

Add two matrices.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator-()

Matrix2D operator-	(	const Matrix2D &	lhs,
		const Matrix2D &	rhs )

Substract two matrices.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator/()

Matrix2D operator/	(	const Matrix2D &	lhs,
		const double &	rhs )

Divide matrix by scalar.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

Public Member Functions

Static Public Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ Matrix2D() [1/7]

◆ Matrix2D() [2/7]

◆ Matrix2D() [3/7]

◆ Matrix2D() [4/7]

◆ Matrix2D() [5/7]

◆ Matrix2D() [6/7]

◆ Matrix2D() [7/7]

Member Function Documentation

◆ A11()

◆ A12()

◆ A21()

◆ A22()

◆ At() [1/2]

◆ At() [2/2]

◆ Det()

◆ Identity()

◆ Inverse()

◆ Invert()

◆ operator!=()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ SetA11()

◆ SetA12()

◆ SetA21()

◆ SetA22()

Friends And Related Symbol Documentation

◆ operator*() [1/4]

◆ operator*() [2/4]

◆ operator*() [3/4]

◆ operator*() [4/4]

◆ operator+()

◆ operator-()

◆ operator/()