Commit 0449a107 authored by BRAMAS Berenger's avatar BRAMAS Berenger

update comments

parent 3ccfe386
......@@ -13,7 +13,7 @@
* <li> Declare index inside the for loop where they are used (and their names should start with "idx" if appropriate) </li>
* <li> Use pre-inc if possible (even if the compiler will optimized post-inc for native type) </li>
* <li> If a parameter is changed by a function use pointer else use const ref (if the size of object is less than 20 Bytes you can pass it by value, moreover if it is intensively used!)</li>
* <li> Please do not name variables with one letter (except if it is related to a mathematical formula but then this one should be in the comment in latex format)</li>
* <li> Please do not name variables with one letter difference (except if it is related to a mathematical formula but then this one should be in the comment in latex format)</li>
* <li> Try not to have function bigger than 100 lines</li>
* <li> Be consistent</li>
* <li> Methods should start with a verb or an action (get, compute, print, etc...)</li>
......@@ -43,7 +43,7 @@
* \subsection pros Pros
<ul>
* <li> It is closed to recent languages.</li>
* <li> It is closed to modern languages.</li>
* <li> It is easy to maintains (you do not have to change the cpp and then the hpp).</li>
* <li> You do not have to put you comment twice or to have an header with comments and a implementation without some.</li>
* <li> It is directly global optimizations to object file and inline is performed directly.</li>
......@@ -59,6 +59,6 @@
* In our project we have plenty of templates.
* Our project is not that big and many people arrived to work on it, and for now, all of them finally like to have all in the hpp when they discovered the project.
* If someone wants to know what a class is proposing, then he can do as it is usual, he looks to the doc (who looks to Qt header to know QVector methods??).
* If someone wants to know what a class is proposing, then he can do as it is usual, he looks to the doc (who looks to Qt header to know QVector methods??) or let his IDE propose the correct methods.
**/
......@@ -35,7 +35,6 @@ method</b> based on interpolation ( Chebyshev or Lagrange).
* and new paradigm of parallelization. </li>
* </ul>
*
*
* To download build and install the application, please see \ref
* install.
*
......
......@@ -11,7 +11,7 @@ cd scalfmm/Build
# Use cmake first by
cmake ..
# Or if you want to use MPI
cmake .. -DScalFMM_USE_MPI=ON
cmake .. -DSCALFMM_USE_MPI=ON
# Configure, for example with:
......@@ -32,6 +32,7 @@ the implementation, kernels and data structure.
# The developer documentation is generated using DOxygen:
cd scalfmm/Build
cmake .. -DSCALFMM_BUILD_DOC=ON
# Tape
make doc
# This will create a Html dir
......
......@@ -31,19 +31,29 @@
* @author Berenger Bramas (berenger.bramas@inria.fr)
* Please read the license
*
* This class defines a container which can holds one type (AttributeClass)
* for each particle.
* The memory is allocated for all informations, the positions and the
* request type.
* This class defines a container which can holds one type (AttributeClass) for each particle.
* The memory is allocated in one block and stores the positions and the request type.
* For example if one wants to store a struct for each particle:
* \code
* struct AStruct{ ... };
* FBasicParticleContainer<1, AStruct> container;
* FBasicParticleContainer<FReal, 1, AStruct> container;
* \endcode
* And then access is done using:
* \code
* AStruct* strucs = container.getAttributes<0>();
* \endcode
* For example if one wants to store 4 doubles for each particles:
* \code
* FBasicParticleContainer<FReal, 4, double> container;
* \endcode
* And then access is done using:
* \code
* double* v1 = container.getAttributes<0>();
* double* v2 = container.getAttributes<1>();
* double* v3 = container.getAttributes<2>();
* double* v4 = container.getAttributes<3>();
* \endcode
* The memory is aligned to FP2PDefaultAlignement value.
*/
template <class FReal, unsigned NbAttributesPerParticle, class AttributeClass >
class FBasicParticleContainer : public FAbstractParticleContainer<FReal>, public FAbstractSerializable {
......
......@@ -26,6 +26,9 @@
* @brief The FError class
* It is recommendede to use the macro:
* FAssertLF( aTest , "some data ", "to ", plot);
* Assertion are enabled or disabled during the compilation.
* If disabled, the test instruction is still used (but the return will be optimized out by
* the compiler).
*/
class FError {
protected:
......
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