Commit fdbeb251 authored by incardon's avatar incardon
Browse files

Fixing documentation

parent ea0c3057
......@@ -214,8 +214,7 @@ public:
* \endverbatim
*
* combination in the center (*) the down-left vertex (+). down and left edge (#)
*
* \param pos slots inside comb to fill with all permutations
*
* \param v vector to fill with the permutations
*
*/
......@@ -248,7 +247,7 @@ public:
}
}
/*! \brief Linearize the Permitation given by BinPermutationSt
/*! \brief Linearize the permutation given by BinPermutationSt
*
* Suppose BinPermutation return the following combination
*
......@@ -258,6 +257,8 @@ public:
*
* \param c combination to linearize
*
* \return the linearized permutation
*
* \see BinPermitationSt
*
*/
......@@ -365,6 +366,8 @@ public:
*
* \param d
*
* \return true if the combination is in positive direction
*
*/
static bool isPositive(size_t d)
{
......
......@@ -142,6 +142,7 @@ struct r_type_dim<1,1,POINT_DIV>
template <unsigned int r, typename orig>
struct r_type_p
{
//! meta-function return orig or the expression produce a vector
typedef orig type;
};
......@@ -153,7 +154,7 @@ struct r_type_p
template <typename orig>
struct r_type_p<1,orig>
{
//! is a vector
//! meta-function return a scalar or the expression produce a scalar
typedef typename orig::coord_type type;
};
......@@ -377,6 +378,13 @@ public:
}
};
/*! \brief expression that subtract two points
*
* \tparam orig original vector
* \tparam exp1 expression 1
* \tparam exp2 expression 2
*
*/
template <typename orig, typename exp1, typename exp2>
class point_expression_op<orig,exp1,exp2, POINT_SUB_UNI >
{
......@@ -455,10 +463,12 @@ class point_expression_op<orig,exp1,exp2,POINT_MUL_POINT>
//! second expression
const exp2 o2;
//! the expression produce a scalar
mutable typename std::remove_const<typename orig::coord_type>::type scal;
public:
//! base type of the expression
typedef orig orig_type;
//! indicate that init must be called before value
......@@ -473,7 +483,12 @@ public:
//! this operation produce a scalar as result
static const unsigned int nvals = 1;
//! constructor from 2 expressions
/*! \brief constructor from 2 expressions
*
* \param o1 expression 1
* \param o2 expression 2
*
*/
inline point_expression_op(const exp1 & o1, const exp2 & o2)
:o1(o1),o2(o2),scal(0.0)
{}
......@@ -545,7 +560,12 @@ public:
//! this operation produce a vector as result of size dims
static const unsigned int nvals = r_type_dim<exp1::nvals,exp2::nvals,POINT_MUL>::value;
//! constructor from 2 expression
/*! \brief constructor from 2 expression
*
* \param o1 expression 1
* \param o2 expression 2
*
*/
inline point_expression_op(const exp1 & o1, const exp2 & o2)
:o1(o1),o2(o2)
{}
......@@ -614,7 +634,12 @@ public:
//! this operation produce a vector as result of size dims
static const unsigned int nvals = r_type_dim<exp1::nvals,exp2::nvals,POINT_DIV>::value;
//! constructor from expression 1 and expression 2
/*! \brief constructor from expression 1 and expression 2
*
* \param o1 expression 1
* \param o2 expression 2
*
*/
inline point_expression_op(const exp1 & o1, const exp2 & o2)
:o1(o1),o2(o2)
{}
......@@ -634,6 +659,8 @@ public:
*
* \param k where to evaluate the expression
*
* \return the value of the expression
*
*/
template<typename r_type=typename std::remove_reference<decltype(o1.value(0))>::type > inline r_type value(size_t k) const
{
......@@ -1244,27 +1271,34 @@ pmul(const point_expression_op<orig,exp1,exp2,op1> & va, const point_expression_
}
/*! \brief Specialization for an array of dimension dim
/*! \brief Specialization for an array of dimension dim as expression
*
* \tparam type
* \tparam T type of the array
* \tparam dim dimensionality of the array
*
*/
template<typename T, unsigned int dim>
class point_expression<T[dim]>
{
//! array of dimension dim
T (& d)[dim];
public:
// indicate that init must be called before value
//! indicate that init must be called before value
typedef int has_init;
// indicate that this class encapsulate an expression
//! indicate that this class encapsulate an expression
typedef int is_expression;
//! this operation produce a vector as result of size dims
static const unsigned int nvals = dim;
/*! \brief constructor from an array
*
* \param d array of dimension dim
*
*/
inline point_expression(T (& d)[dim])
:d(d)
{
......@@ -1317,27 +1351,34 @@ public:
};
/*! \brief Specialization for an array of dimension dim
/*! \brief Specialization for a const array of dimension dim
*
* \tparam type
* \tparam T type of the array
* \tparam dim dimensionality of the array
*
*/
template<typename T, unsigned int dim>
class point_expression<const T[dim]>
{
//! array of dimensions dim
const T (& d)[dim];
public:
// indicate that init must be called before value
//! indicate that init must be called before value
typedef int has_init;
// indicate that this class encapsulate an expression
//! indicate that this class encapsulate an expression
typedef int is_expression;
//! this operation produce a vector as result of size dims
static const unsigned int nvals = dim;
/*! \brief construct from an array of dimension dim
*
* \param d array
*
*/
inline point_expression(const T (& d)[dim])
:d(d)
{
......
......@@ -16,14 +16,18 @@
template<typename bfv>
struct copy_fusion_vector
{
//! source fusion vector
const bfv & src;
//! destination fusion vector
bfv & dst;
/*! \brief constructor
*
* It define the copy parameters.
*
* \param obj object we have to set in grid_dst
* \param src source fusion vector
* \param dst destination fusion vector
*
*/
inline copy_fusion_vector(const bfv & src, bfv & dst)
......@@ -64,14 +68,18 @@ struct copy_fusion_vector
template<typename bfv, typename enc>
struct copy_fusion_vector_encap
{
//! source fusion vector
const bfv & src;
//! destination fusion vector
enc & dst;
/*! \brief constructor
*
* It define the copy parameters.
*
* \param obj object we have to set in grid_dst
* \param src source fusion vector
* \param dst destination fusion vector
*
*/
inline copy_fusion_vector_encap(const bfv & src, enc & dst)
......@@ -93,12 +101,6 @@ struct copy_fusion_vector_encap
template<typename T>
inline void operator()(T& t)
{
// This is the type of the object we have to copy
// typedef typename boost::fusion::result_of::at_c<bfv,T::value>::type copy_type;
// Remove the reference from the type to copy
// typedef typename boost::remove_reference<copy_type>::type copy_rtype;
meta_copy_d<typename boost::mpl::at<bfv,boost::mpl::int_<T::value> >::type,decltype(dst.template get<T::value>())>::meta_copy_d_(boost::fusion::at_c<T::value>(src),dst.template get<T::value>());
}
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment