* Calculates the sum of a column of an intersection matrix
*
* @param m an intersection matrix
- * @param i the index of the column (0 <= i <= #rows - 1)
+ * @param i the index of the column (0 <= i <= no. rows - 1)
* @return the sum of the values of column i
*
*/
for(map<int, double>::const_iterator iter2 = iter->begin() ; iter2 != iter->end() ; ++iter2)
{
volumes.push_back(iter2->second);
- // vol += std::abs(iter2->second);
}
}
/**
* Tests if an intersection matrix is diagonal.
*
- * @param the intersection matrix
+ * @param m the intersection matrix
* @return true if m is diagonal; false if not
*
*/
// Correspondance tables describing all the variations of formulas.
// ----------------------------------------------------------------------------------
- /// Correspondance between facets and double products.
+ /// \brief Correspondance between facets and double products.
+ ///
/// This table encodes Grandy, table IV. Use 3*facet + {0,1,2} as index
const TransformedTriangle::DoubleProduct TransformedTriangle::DP_FOR_SEG_FACET_INTERSECTION[12] =
{
C_XH, C_YH, C_ZH // XYZ
};
- /// Signs associated with entries in DP_FOR_SEGMENT_FACET_INTERSECTION
+ /// \brief Signs associated with entries in DP_FOR_SEGMENT_FACET_INTERSECTION.
+ ///
/// This table encodes Grandy, table IV. Use 3*facet + {0,1,2} as index
const double TransformedTriangle::SIGN_FOR_SEG_FACET_INTERSECTION[12] =
{
1.0, 1.0, 1.0
};
- /// Coordinates of corners of tetrahedron.
+ /// \brief Coordinates of corners of tetrahedron.
+ ///
/// Use 3*Corner + coordinate as index
const double TransformedTriangle::COORDS_TET_CORNER[12] =
{
0.0, 0.0, 1.0
};
- /// Indices to use in tables DP_FOR_SEG_FACET_INTERSECTION and SIGN_FOR_SEG_FACET_INTERSECTION
+ /// \brief Indices to use in tables DP_FOR_SEG_FACET_INTERSECTION and SIGN_FOR_SEG_FACET_INTERSECTION
/// for the calculation of the coordinates (x,y,z) of the intersection points
/// for Segment-Facet and Segment-Edge intersections.
+ ///
/// Use 3*facet + coordinate as index. -1 indicates that the coordinate is 0.
const int TransformedTriangle::DP_INDEX[12] =
{
9, 10, 11 // XYZ
};
- /// Correspondance edge - corners
+ /// \brief Correspondance edge - corners.
+ ///
/// Gives the two corners associated with each edge
/// Use 2*edge + {0, 1} as index
const TransformedTriangle::TetraCorner TransformedTriangle::CORNERS_FOR_EDGE[12] =
Z, X // ZX
};
- /// Correspondance edge - facets.
+ /// \brief Correspondance edge - facets.
+ ///
/// Gives the two facets shared by and edge. Use 2*facet + {0, 1} as index
const TransformedTriangle::TetraFacet TransformedTriangle::FACET_FOR_EDGE[12] =
{
OZX, XYZ // ZX
};
- /// Correspondance corners - edges
+ /// \brief Correspondance corners - edges.
+ ///
/// Gives edges meeting at a given corner. Use 3*corner + {0,1,2} as index
const TransformedTriangle::TetraEdge TransformedTriangle::EDGES_FOR_CORNER[12] =
{
OZ, ZX, YZ // Z
};
- /// Double products to use in halfstrip intersection tests
+ /// \brief Double products to use in halfstrip intersection tests.
+ ///
/// Use 4*(offset_edge) + {0,1,2,3} as index. offset_edge = edge - 3 (so that XY -> 0, YZ -> 1, ZX -> 2)
/// Entries with offset 0 and 1 are for the first condition (positive product)
/// and those with offset 2 and 3 are for the second condition (negative product).
C_XY, C_10, C_YH, C_XY // ZX
};
- /// Double products to use in segment-ray test
+ /// \brief Double products to use in segment-ray test.
+ ///
/// Use 7*corner_offset + {0,1,2,3,4,5,6} as index. corner_offset = corner - 1 (so that X -> 0, Y-> 1, Z->2)
/// Entries with offset 0 are for first condition (zero double product) and the rest are for condition 3 (in the same
/// order as in the article)
