Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tools
frackit
Commits
272c90cc
Commit
272c90cc
authored
Jan 27, 2020
by
Dennis Gläser
Browse files
[doc][doxygen] add group specs to files in common
parent
93cc62c8
Changes
7
Hide whitespace changes
Inline
Side-by-side
frackit/common/extractctype.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Type traits to extract the coordinate type of geometric objects.
*/
#ifndef FRACKIT_COMMON_COORDINATE_TYPE_HH
...
...
@@ -37,6 +38,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Traits class to extract the coordinate type from a geometry.
* \note This is the specialization used for internal geometry types
* which carry the information of the coordinate type themselves.
...
...
frackit/common/extractdimension.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Type traits to extract the dimensionality of geometric objects.
*/
#ifndef FRACKIT_COMMON_EXTRACT_DIMENSION_HH
...
...
@@ -37,6 +38,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Traits class to extract the dimensionalty of a geometry.
* \note This is the specialization used for internal geometry types
* which carry the information of the dimensions themselves.
...
...
frackit/common/id.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Simple wrapper class to define ids/indices.
*/
#ifndef FRACKIT_ID_HH
...
...
@@ -26,6 +27,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Simple wrapper class to define ids/indices.
* This can be used wherever indices are passed
* to interfaces to avoid implicit conversion of
...
...
frackit/common/idpair.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Simple class to define pairs of ids.
*/
#ifndef FRACKIT_ID_PAIR_HH
...
...
@@ -30,6 +31,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Simple class to define pairs of ids.
*/
class
IdPair
...
...
frackit/common/math.hh
View file @
272c90cc
...
...
@@ -18,7 +18,8 @@
*****************************************************************************/
/*!
* \file
* \brief Define some mathematical functions
* \ingroup Common
* \brief Defines some mathematical functions.
*/
#ifndef FRACKIT_MATH_HH
#define FRACKIT_MATH_HH
...
...
@@ -32,6 +33,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Returns the vector resulting from the cross product
* of two 3-dimensional vectors.
*/
...
...
@@ -45,6 +47,7 @@ Vector<ctype, 3> crossProduct(const Vector<ctype, 3>& v1,
}
/*!
* \ingroup Common
* \brief Returns the scalar resulting from the cross product
* of two 2-dimensional vectors.
*/
...
...
@@ -54,6 +57,7 @@ ctype crossProduct(const Vector<ctype, 2>& v1,
{
return
v1
.
x
()
*
v2
.
y
()
-
v1
.
y
()
*
v2
.
x
();
}
/*!
* \ingroup Common
* \brief Returns the scalar resulting from the box product
* of three 3-dimensional vectors.
*/
...
...
@@ -64,6 +68,7 @@ ctype boxProduct(const Vector<ctype, 3>& v1,
{
return
v1
*
crossProduct
(
v2
,
v3
);
}
/*!
* \ingroup Common
* \brief Returns true if the given 3-dimensional
* vectors form a right-hand system.
*/
...
...
@@ -79,6 +84,7 @@ bool isRightHandSystem(const Vector<ctype, 3>& v1,
}
/*!
* \ingroup Common
* \brief Converts a given angle in radians to degrees.
*/
template
<
class
ctype
>
...
...
@@ -86,6 +92,7 @@ ctype toDegrees(const ctype radians)
{
return
radians
*
180.0
/
M_PI
;
}
/*!
* \ingroup Common
* \brief Converts a given angle in degrees to radians.
*/
template
<
class
ctype
>
...
...
@@ -93,6 +100,7 @@ ctype toRadians(const ctype degrees)
{
return
degrees
*
M_PI
/
180.0
;
}
/*!
* \ingroup Common
* \brief Rotate a vector around an axis by a given angle.
* \param v The vector to be rotated
* \param axis The rotation axis
...
...
@@ -124,6 +132,7 @@ void rotate(Vector<ctype, 3>& v,
}
/*!
* \ingroup Common
* \brief Rotate several vectors around an axis by a given angle.
* \param vectors The vectors to be rotated
* \param axis The rotation axis
...
...
frackit/common/promotedtype.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Determines the type that results from arithmetic
* operations on two different number types.
*/
...
...
@@ -29,9 +30,10 @@
namespace
Frackit
{
/*!
* \brief Determines the type that results from arithmetic
* operations on two different number types.
*/
* \ingroup Common
* \brief Determines the type that results from arithmetic
* operations on two different number types.
*/
template
<
class
T1
,
class
T2
>
struct
PromotionTraits
{
...
...
@@ -43,8 +45,9 @@ template<class T1>
struct
PromotionTraits
<
T1
,
T1
>
{
typedef
T1
PromotedType
;
};
/*!
* \brief Convenience alias to get the promoted type
*/
* \ingroup Common
* \brief Convenience alias to get the promoted type
*/
template
<
class
T1
,
class
T2
>
using
PromotedType
=
typename
PromotionTraits
<
T1
,
T2
>::
PromotedType
;
...
...
frackit/common/typetraits.hh
View file @
272c90cc
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \brief Defines classes to obtain type information at compile-time.
*/
#ifndef FRACKIT_COMMON_TYPE_TRAITS_HH
...
...
@@ -28,6 +29,7 @@
namespace
Frackit
{
/*!
* \ingroup Common
* \brief Helper struct to detect if a type T
* is contained in a parameter pack Ts
* \tparam T The type of which an ocurrence in the pack is to be checked
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment