mirror of https://github.com/CGAL/cgal
37 lines
1.0 KiB
TeX
37 lines
1.0 KiB
TeX
\begin{ccRefClass} {Ambient_dimension<T, K = Kernel_traits<T>::Kernel>}
|
|
|
|
\ccDefinition
|
|
The class \ccRefName\ allows to retrieve the dimension of the ambient space of
|
|
a type.
|
|
|
|
\ccInclude{CGAL/Dimension.h}
|
|
|
|
\ccConstants
|
|
|
|
\ccVariable{static const int value;}{The dimension value as a compile-time
|
|
integral constant. It is implemented as \ccc{K::Dimension<T>::type::value}.
|
|
It exists only when the dimension is a compile-time constant.}
|
|
|
|
\ccTypes
|
|
|
|
\ccTypedef{type;}{Either \ccc{Dimension_tag<dim>} if the dimension is a
|
|
compile-time constant of value \ccc{dim}, or \ccc{Dynamic_dimension_tag}
|
|
otherwise. It is implemented as \ccc{K::Ambient_dimension<T>::type}. }
|
|
|
|
\ccExample
|
|
|
|
The following retrieves the dimension of a point type.
|
|
|
|
\begin{cprog}
|
|
typedef K::Point_2 Point;
|
|
int dimension = Ambient_dimension<Point, K>::value;
|
|
assert(dimension == 2);
|
|
\end{cprog}
|
|
|
|
\ccSeeAlso
|
|
\ccRefConceptPage{Dimension_tag} \\
|
|
\ccRefConceptPage{Dynamic_dimension_tag} \\
|
|
\ccRefConceptPage{CGAL::Feature_dimension<T, K = Kernel_traits<T>::Kernel>}
|
|
|
|
\end{ccRefClass}
|