Detailed Description

template<typename T, fcppt::math::size_type R, fcppt::math::size_type C, typename S>
class fcppt::math::matrix::object< T, R, C, S >

A class representing a static matrix.

Represents a static R by C matrix, which is a matrix consisting of R rows and C columns.

Template Parameters

T	The matrix's `value_type`
R	The number of rows
C	The number of columns
S	The matrix's storage type

See fcppt.math.matrix for more information.

Public Types
using	static_rows = fcppt::math::static_size<R>

using	static_columns = fcppt::math::static_size<C>

using	static_size = static_rows

using	dim_wrapper = fcppt::math::static_size<static_rows::value * static_columns::value>

using	storage_type = S
	A typedef for the `S` parameter.

using	size_type = fcppt::math::size_type
	A type that counts the number of elements in a matrix.

using	difference_type = fcppt::math::difference_type
	A type that provides the difference between the addresses of two elements in a matrix.

using	value_type = T
	A type that represents the data type stored in a matrix.

using	reference
	A reference to a row of the matrix.

using	inner_reference = typename reference::reference
	A reference to an element of the matrix.

using	const_reference
	A const reference to a row of the matrix.

using	const_inner_reference = typename const_reference::const_reference
	A const reference to an element of the matrix.

using	row_type = fcppt::math::matrix::row_type<T, C>
	The type of a row, which is a vector of `C` elements.

Public Member Functions
	object (fcppt::no_init const &)
	Construct an uninitialized matrix.

	object (storage_type &&)
	Construct a matrix from a storage source.

template<typename... Args> requires (std::conjunction_v< std::bool_constant<sizeof...(Args) == R>, std::is_same<fcppt::math::matrix::row_type<T, C>, std::remove_cvref_t<Args>>...>)
	object (Args &&...)
	Constructs a matrix from `R` rows.

template<typename OtherStorage >
	object (fcppt::math::matrix::object< T, R, C, OtherStorage > const &)
	Create a matrix from a matrix with the same dimension and value type but different storage type.

template<typename OtherStorage >
object &	operator= (fcppt::math::matrix::object< T, R, C, OtherStorage > const &)
	Copy the values from a different matrix of the same size but different storage type.

template<typename S2 >
object &	operator+= (object< T, R, C, S2 > const &)

template<typename S2 >
object &	operator-= (object< T, R, C, S2 > const &)

object &	operator*= (value_type const &)
	Multiply a matrix by a scalar.

reference	get_unsafe (size_type)
	Returns a reference to a row in the matrix.

const_reference	get_unsafe (size_type) const
	Returns a reference to a (constant) row in the matrix.

S &	storage ()

S const &	storage () const

inner_reference	m00 ()

const_inner_reference	m00 () const

inner_reference	m01 ()

const_inner_reference	m01 () const

inner_reference	m02 ()

const_inner_reference	m02 () const

inner_reference	m03 ()

const_inner_reference	m03 () const

inner_reference	m10 ()

const_inner_reference	m10 () const

inner_reference	m11 ()

const_inner_reference	m11 () const

inner_reference	m12 ()

const_inner_reference	m12 () const

inner_reference	m13 ()

const_inner_reference	m13 () const

inner_reference	m20 ()

const_inner_reference	m20 () const

inner_reference	m21 ()

const_inner_reference	m21 () const

inner_reference	m22 ()

const_inner_reference	m22 () const

inner_reference	m23 ()

const_inner_reference	m23 () const

inner_reference	m30 ()

const_inner_reference	m30 () const

inner_reference	m31 ()

const_inner_reference	m31 () const

inner_reference	m32 ()

const_inner_reference	m32 () const

inner_reference	m33 ()

const_inner_reference	m33 () const

Static Public Member Functions
static constexpr size_type	rows ()
	Returns the number of rows in the matrix.

static constexpr size_type	columns ()
	Returns the number of columns in the matrix.

Member Typedef Documentation

◆ const_inner_reference

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::const_inner_reference = typename const_reference::const_reference

A const reference to an element of the matrix.

◆ const_reference

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::const_reference

Initial value:

fcppt::math::vector::object<T, C, fcppt::math::matrix::detail::row_view<T, C, S const>>

A const reference to a row of the matrix.

◆ difference_type

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::difference_type = fcppt::math::difference_type

A type that provides the difference between the addresses of two elements in a matrix.

◆ dim_wrapper

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::dim_wrapper = fcppt::math::static_size<static_rows::value * static_columns::value>

◆ inner_reference

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::inner_reference = typename reference::reference

A reference to an element of the matrix.

◆ reference

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::reference

Initial value:

fcppt::math::vector::object<T, C, fcppt::math::matrix::detail::row_view<T, C, S>>

A reference to a row of the matrix.

◆ row_type

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::row_type = fcppt::math::matrix::row_type<T, C>

The type of a row, which is a vector of C elements.

◆ size_type

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::size_type = fcppt::math::size_type

A type that counts the number of elements in a matrix.

◆ static_columns

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::static_columns = fcppt::math::static_size<C>

◆ static_rows

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::static_rows = fcppt::math::static_size<R>

◆ static_size

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::static_size = static_rows

◆ storage_type

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::storage_type = S

A typedef for the S parameter.

◆ value_type

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

using fcppt::math::matrix::object< T, R, C, S >::value_type = T

A type that represents the data type stored in a matrix.

Constructor & Destructor Documentation

◆ object() [1/4]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

fcppt::math::matrix::object< T, R, C, S >::object ( fcppt::no_init const & )

explicit

Construct an uninitialized matrix.

Warning: The content of the matrix will be undefined (not null) after initialization

◆ object() [2/4]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

fcppt::math::matrix::object< T, R, C, S >::object ( storage_type && )

explicit

Construct a matrix from a storage source.

◆ object() [3/4]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

template<typename... Args>
requires (std::conjunction_v< std::bool_constant<sizeof...(Args) == R>, std::is_same<fcppt::math::matrix::row_type<T, C>, std::remove_cvref_t<Args>>...>)

fcppt::math::matrix::object< T, R, C, S >::object ( Args && ... )

explicit

Constructs a matrix from R rows.

Constructs a matrix by using R arguments of type fcppt::math::matrix::object::row_type. You can use fcppt::math::matrix::row to create them.

◆ object() [4/4]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

template<typename OtherStorage >

fcppt::math::matrix::object< T, R, C, S >::object ( fcppt::math::matrix::object< T, R, C, OtherStorage > const & )

explicit

Create a matrix from a matrix with the same dimension and value type but different storage type.

Template Parameters

OtherStorage The other matrix's storage type

Member Function Documentation

◆ columns()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

static constexpr size_type fcppt::math::matrix::object< T, R, C, S >::columns ( )

staticnodiscardconstexpr

Returns the number of columns in the matrix.

◆ get_unsafe() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

reference fcppt::math::matrix::object< T, R, C, S >::get_unsafe ( size_type )

nodiscard

Returns a reference to a row in the matrix.

Warning: Behaviour is undefined if the index is out of range.

◆ get_unsafe() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_reference fcppt::math::matrix::object< T, R, C, S >::get_unsafe ( size_type ) const

nodiscard

Returns a reference to a (constant) row in the matrix.

Warning: Behaviour is undefined if the index is out of range.

◆ m00() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m00 ( )

nodiscard

◆ m00() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m00 ( ) const

nodiscard

◆ m01() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m01 ( )

nodiscard

◆ m01() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m01 ( ) const

nodiscard

◆ m02() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m02 ( )

nodiscard

◆ m02() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m02 ( ) const

nodiscard

◆ m03() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m03 ( )

nodiscard

◆ m03() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m03 ( ) const

nodiscard

◆ m10() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m10 ( )

nodiscard

◆ m10() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m10 ( ) const

nodiscard

◆ m11() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m11 ( )

nodiscard

◆ m11() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m11 ( ) const

nodiscard

◆ m12() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m12 ( )

nodiscard

◆ m12() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m12 ( ) const

nodiscard

◆ m13() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m13 ( )

nodiscard

◆ m13() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m13 ( ) const

nodiscard

◆ m20() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m20 ( )

nodiscard

◆ m20() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m20 ( ) const

nodiscard

◆ m21() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m21 ( )

nodiscard

◆ m21() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m21 ( ) const

nodiscard

◆ m22() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m22 ( )

nodiscard

◆ m22() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m22 ( ) const

nodiscard

◆ m23() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m23 ( )

nodiscard

◆ m23() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m23 ( ) const

nodiscard

◆ m30() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m30 ( )

nodiscard

◆ m30() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m30 ( ) const

nodiscard

◆ m31() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m31 ( )

nodiscard

◆ m31() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m31 ( ) const

nodiscard

◆ m32() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m32 ( )

nodiscard

◆ m32() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m32 ( ) const

nodiscard

◆ m33() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

inner_reference fcppt::math::matrix::object< T, R, C, S >::m33 ( )

nodiscard

◆ m33() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

const_inner_reference fcppt::math::matrix::object< T, R, C, S >::m33 ( ) const

nodiscard

◆ operator*=()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

object & fcppt::math::matrix::object< T, R, C, S >::operator*= ( value_type const & )

Multiply a matrix by a scalar.

◆ operator+=()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

template<typename S2 >

object & fcppt::math::matrix::object< T, R, C, S >::operator+= ( object< T, R, C, S2 > const & )

◆ operator-=()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

template<typename S2 >

object & fcppt::math::matrix::object< T, R, C, S >::operator-= ( object< T, R, C, S2 > const & )

◆ operator=()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

template<typename OtherStorage >

object & fcppt::math::matrix::object< T, R, C, S >::operator= ( fcppt::math::matrix::object< T, R, C, OtherStorage > const & )

Copy the values from a different matrix of the same size but different storage type.

Template Parameters

OtherStorage The other matrix's storage type

◆ rows()

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

static constexpr size_type fcppt::math::matrix::object< T, R, C, S >::rows ( )

staticnodiscardconstexpr

Returns the number of rows in the matrix.

◆ storage() [1/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

S & fcppt::math::matrix::object< T, R, C, S >::storage ( )

nodiscard

◆ storage() [2/2]

template<typename T , fcppt::math::size_type R, fcppt::math::size_type C, typename S >

S const & fcppt::math::matrix::object< T, R, C, S >::storage ( ) const

nodiscard

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ const_inner_reference

◆ const_reference

◆ difference_type

◆ dim_wrapper

◆ inner_reference

◆ reference

◆ row_type

◆ size_type

◆ static_columns

◆ static_rows

◆ static_size

◆ storage_type

◆ value_type

Constructor & Destructor Documentation

◆ object() [1/4]

◆ object() [2/4]

◆ object() [3/4]

◆ object() [4/4]

Member Function Documentation

◆ columns()

◆ get_unsafe() [1/2]

◆ get_unsafe() [2/2]

◆ m00() [1/2]

◆ m00() [2/2]

◆ m01() [1/2]

◆ m01() [2/2]

◆ m02() [1/2]

◆ m02() [2/2]

◆ m03() [1/2]

◆ m03() [2/2]

◆ m10() [1/2]

◆ m10() [2/2]

◆ m11() [1/2]

◆ m11() [2/2]

◆ m12() [1/2]

◆ m12() [2/2]

◆ m13() [1/2]

◆ m13() [2/2]

◆ m20() [1/2]

◆ m20() [2/2]

◆ m21() [1/2]

◆ m21() [2/2]

◆ m22() [1/2]

◆ m22() [2/2]

◆ m23() [1/2]

◆ m23() [2/2]

◆ m30() [1/2]

◆ m30() [2/2]

◆ m31() [1/2]

◆ m31() [2/2]

◆ m32() [1/2]

◆ m32() [2/2]

◆ m33() [1/2]

◆ m33() [2/2]

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ rows()

◆ storage() [1/2]

◆ storage() [2/2]