Dimensions.hpp File Reference

Definition of the Dimensions class. More...

#include <cstddef>
#include "collections/collections.hpp"
#include "patterns/interfaces/pattern_descriptor_traits.hpp"
#include "patterns/concepts/fixed_pattern.hpp"
#include "patterns/concepts/dynamic_pattern.hpp"
#include "patterns/concepts/euclidean_pattern.hpp"
#include "patterns/traits/dimension_of.hpp"
#include "patterns/functions/get_dimension.hpp"
#include "Any.hpp"

Include dependency graph for Dimensions.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	OpenKalman::patterns::Dimensions< N >
	A structure representing the dimensions associated with of a particular index. More...
struct	OpenKalman::patterns::Dimensions< stdex::dynamic_extent >
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
struct	OpenKalman::interface::pattern_descriptor_traits< patterns::Dimensions< N > >
struct	std::common_type< OpenKalman::patterns::Dimensions< M >, OpenKalman::patterns::Dimensions< N > >
struct	std::common_type< OpenKalman::patterns::Dimensions< N >, T >
struct	std::common_type< OpenKalman::patterns::Dimensions< N >, OpenKalman::patterns::Any< Scalar > >
struct	std::common_type< OpenKalman::patterns::Any< Scalar >, OpenKalman::patterns::Dimensions< N > >
struct	std::common_type< std::integral_constant< T, M >, OpenKalman::patterns::Dimensions< N > >
struct	std::common_type< OpenKalman::values::fixed_value< T, M... >, OpenKalman::patterns::Dimensions< N > >
struct	std::common_type< OpenKalman::values::consteval_operation< Args... >, OpenKalman::patterns::Dimensions< N > >

Namespaces
	OpenKalman::patterns
	The namespace for features relating to patterns::pattern object.

Macros
#define	OPENKALMAN_INDEX_STD_COMMON_TYPE_SPECIALIZATION(I)

Typedefs
using	OpenKalman::patterns::Axis = Dimensions< 1 >
	Alias for a 1D Euclidean patterns::pattern object.

Functions
template<typename D , std::enable_if_t< fixed_pattern< D > and euclidean_pattern< D >, int > = 0>
	OpenKalman::patterns::Dimensions (D &&) -> Dimensions< dimension_of< D >::value >
	OpenKalman::patterns::Dimensions (const std::size_t &) -> Dimensions< stdex::dynamic_extent >

Detailed Description

Definition of the Dimensions class.

Macro Definition Documentation

OPENKALMAN_INDEX_STD_COMMON_TYPE_SPECIALIZATION

#define OPENKALMAN_INDEX_STD_COMMON_TYPE_SPECIALIZATION

(

I

)

Value:

namespace std                                                       \
{                                                                   \
  template<std::size_t N>                                           \
  struct common_type<I, OpenKalman::patterns::Dimensions<N>>     \
    : common_type<OpenKalman::patterns::Dimensions<N>, I> {};    \
}