Commit 9c74d2c1 authored by Quentin Khan's avatar Quentin Khan

FTreeCoordinate: Realign comments

parent 376dbb51
......@@ -25,15 +25,15 @@
#include "../Components/FAbstractSerializable.hpp"
/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class FTreeCoordinate
* Please read the license
*
* This class represents tree coordinate. It is used to save
* the position in "box unit" (not system/space unit!).
* It is directly related to morton index, as interleaves
* bits from this coordinate make the morton index
*/
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class FTreeCoordinate
* Please read the license
*
* This class represents tree coordinate. It is used to save
* the position in "box unit" (not system/space unit!).
* It is directly related to morton index, as interleaves
* bits from this coordinate make the morton index
*/
class FTreeCoordinate : public FAbstractSerializable, public FPoint<int, 3> {
private:
using point_t = FPoint<int, 3>;
......@@ -84,10 +84,10 @@ public:
{}
/**
* Copy assignment
* @param other the source class to copy
* @return this a reference to the current object
*/
* Copy assignment
* @param other the source class to copy
* @return this a reference to the current object
*/
FTreeCoordinate& operator=(const FTreeCoordinate& other) = default;
[[gnu::deprecated]]
......@@ -97,11 +97,11 @@ public:
/**
* To get the morton index of the current position
* @complexity inLevel
* @param inLevel the level of the component
* @return morton index
*/
* To get the morton index of the current position
* @complexity inLevel
* @param inLevel the level of the component
* @return morton index
*/
MortonIndex getMortonIndex() const{
MortonIndex index = 0x0LL;
MortonIndex mask = 0x1LL;
......@@ -157,9 +157,9 @@ public:
/** Test equal operator
* @param other the coordinate to compare
* @return true if other & current object have same position
*/
* @param other the coordinate to compare
* @return true if other & current object have same position
*/
bool equals(const int inX, const int inY, const int inZ) const {
return point_t::data()[0] == inX
&& point_t::data()[1] == inY
......
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