fcppt::math::vector::object< T, N, S > Class Template Reference

Detailed Description

template<typename T, fcppt::math::size_type N, typename S>
class fcppt::math::vector::object< T, N, S >

A class representing static n-dimensional vectors.

Template Parameters

T	The vector's value_type
N	The vector's dimension
S	The vector's storage type

See fcppt.math.vector for more information.

Public Types
using	dim_wrapper = fcppt::math::static_size<N>
	A typedef for the N parameter.
using	static_size = dim_wrapper
	The static size.
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 vector.
using	difference_type = fcppt::math::difference_type
	A type that provides the difference between the addresses of two elements in a vector.
using	value_type = T
	A type that represents the data type stored in a vector.
using	reference = typename storage_type::reference
	A type that provides a reference to an element stored in a vector.
using	const_reference = typename storage_type::const_reference
	A type that provides a reference to a const element stored in a vector for reading and performing const operations.

Public Member Functions
	object (fcppt::no_init const &)
	Construct an uninitialized vector.
	object (storage_type &&)
	Construct a vector from a storage source.
template<typename... Args> requires (std::conjunction_v< fcppt::math::is_static_storage<S>, std::bool_constant<sizeof...(Args) == N>, std::is_constructible<T, Args>...>)
constexpr	object (Args &&...) noexcept(std::conjunction_v< std::is_nothrow_constructible< T, Args >... >)
template<typename OtherStorage>
	object (fcppt::math::vector::object< T, N, OtherStorage > const &)
	Create a vector from a vector with the same dimension and value type but different storage type.
template<typename OtherStorage>
object &	operator= (fcppt::math::vector::object< T, N, OtherStorage > const &)
	Copy the values from a different vector.
template<typename S2>
object &	operator+= (object< T, N, S2 > const &)
	Add a vector.
template<typename S2>
object &	operator-= (object< T, N, S2 > const &)
	Subtract a vector.
template<typename S2>
object &	operator*= (object< T, N, S2 > const &)
	Multiply by a vector.
object &	operator*= (value_type const &)
	Multiply a vector by a scalar.
const_reference	get_unsafe (size_type) const
	Returns a reference to the vector element at a specified position.
reference	get_unsafe (size_type)
	Returns a reference to the vector element at a specified position.
reference	x ()
	Returns a reference to the first element in the vector.
const_reference	x () const
	Returns a reference to the first element in the vector.
reference	y ()
	Returns a reference to the second element in the vector.
const_reference	y () const
	Returns a reference to the second element in the vector.
reference	z ()
	Returns a reference to the third element in the vector.
const_reference	z () const
	Returns a reference to the third element in the vector.
reference	w ()
	Returns a reference to the fourth element in the vector.
const_reference	w () const
	Returns a reference to the fourth element in the vector.
S &	storage ()
S const &	storage () const

Member Typedef Documentation

const_reference

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::const_reference = typename storage_type::const_reference

A type that provides a reference to a const element stored in a vector for reading and performing const operations.

difference_type

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::difference_type = fcppt::math::difference_type

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

dim_wrapper

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::dim_wrapper = fcppt::math::static_size<N>

A typedef for the N parameter.

reference

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::reference = typename storage_type::reference

A type that provides a reference to an element stored in a vector.

size_type

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::size_type = fcppt::math::size_type

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

static_size

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::static_size = dim_wrapper

The static size.

storage_type

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::storage_type = S

A typedef for the S parameter.

value_type

template<typename T, fcppt::math::size_type N, typename S>

using fcppt::math::vector::object< T, N, S >::value_type = T

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

Constructor & Destructor Documentation

object() [1/4]

template<typename T, fcppt::math::size_type N, typename S>

fcppt::math::vector::object< T, N, S >::object ( fcppt::no_init const & )

explicit

Construct an uninitialized vector.

Warning

The content of the vector will be undefined (not null) after initialization

object() [2/4]

template<typename T, fcppt::math::size_type N, typename S>

fcppt::math::vector::object< T, N, S >::object ( storage_type && )

explicit

Construct a vector from a storage source.

object() [3/4]

template<typename T, fcppt::math::size_type N, typename S>

template<typename... Args>
requires (std::conjunction_v< fcppt::math::is_static_storage<S>, std::bool_constant<sizeof...(Args) == N>, std::is_constructible<T, Args>...>)

fcppt::math::vector::object< T, N, S >::object ( Args && ... ) const

explicitconstexprnoexcept

object() [4/4]

template<typename T, fcppt::math::size_type N, typename S>

template<typename OtherStorage>

fcppt::math::vector::object< T, N, S >::object ( fcppt::math::vector::object< T, N, OtherStorage > const & )

explicit

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

Template Parameters

OtherStorage

The other vector's storage type

Member Function Documentation

get_unsafe() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

reference fcppt::math::vector::object< T, N, S >::get_unsafe ( size_type )

nodiscard

Returns a reference to the vector element at a specified position.

Warning

Behaviour is undefined if the index is out of range.

get_unsafe() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

const_reference fcppt::math::vector::object< T, N, S >::get_unsafe ( size_type ) const

nodiscard

Returns a reference to the vector element at a specified position.

Warning

Behaviour is undefined if the index is out of range.

operator*=() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

template<typename S2>

object & fcppt::math::vector::object< T, N, S >::operator*=

(

object< T, N, S2 > const &

)

Multiply by a vector.

operator*=() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

object & fcppt::math::vector::object< T, N, S >::operator*=

(

value_type const &

)

Multiply a vector by a scalar.

operator+=()

template<typename T, fcppt::math::size_type N, typename S>

template<typename S2>

object & fcppt::math::vector::object< T, N, S >::operator+=

(

object< T, N, S2 > const &

)

Add a vector.

operator-=()

template<typename T, fcppt::math::size_type N, typename S>

template<typename S2>

object & fcppt::math::vector::object< T, N, S >::operator-=

(

object< T, N, S2 > const &

)

Subtract a vector.

operator=()

template<typename T, fcppt::math::size_type N, typename S>

template<typename OtherStorage>

object & fcppt::math::vector::object< T, N, S >::operator=

(

fcppt::math::vector::object< T, N, OtherStorage > const &

)

Copy the values from a different vector.

Template Parameters

OtherStorage

The other vector's storage type

storage() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

S & fcppt::math::vector::object< T, N, S >::storage ( )

nodiscard

storage() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

S const & fcppt::math::vector::object< T, N, S >::storage ( ) const

nodiscard

w() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

reference fcppt::math::vector::object< T, N, S >::w ( )

nodiscard

Returns a reference to the fourth element in the vector.

w() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

const_reference fcppt::math::vector::object< T, N, S >::w ( ) const

nodiscard

Returns a reference to the fourth element in the vector.

x() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

reference fcppt::math::vector::object< T, N, S >::x ( )

nodiscard

Returns a reference to the first element in the vector.

x() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

const_reference fcppt::math::vector::object< T, N, S >::x ( ) const

nodiscard

Returns a reference to the first element in the vector.

y() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

reference fcppt::math::vector::object< T, N, S >::y ( )

nodiscard

Returns a reference to the second element in the vector.

y() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

const_reference fcppt::math::vector::object< T, N, S >::y ( ) const

nodiscard

Returns a reference to the second element in the vector.

z() [1/2]

template<typename T, fcppt::math::size_type N, typename S>

reference fcppt::math::vector::object< T, N, S >::z ( )

nodiscard

Returns a reference to the third element in the vector.

z() [2/2]

template<typename T, fcppt::math::size_type N, typename S>

const_reference fcppt::math::vector::object< T, N, S >::z ( ) const

nodiscard

Returns a reference to the third element in the vector.