Unverified Commit 3089205a authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

tweak MyPage docs

parent 0447616a
Loading
Loading
Loading
Loading
+10 −8
Original line number Diff line number Diff line
@@ -54,11 +54,13 @@ using namespace LAMMPS_NS;
/** \class LAMMPS_NS::MyPage
 * \brief Templated class for storing chunks of datums in pages.
 *
 * The chunks are not returnable (i.e. cannot be freed individually).
 * One can only reset and start over.  The purpose of this
 * class is to replace many small memory allocations via malloc() with
 * a few large ones. Since the pages are never freed, they can be
 * re-used without having to re-allocate them.
 * The size of the chunk may vary from call to call, but must be
 * less or equal than the *maxchunk* setting.
 * The chunks are not returnable like with malloc() (i.e. you cannot
 * call free() on them individually).  One can only reset and start over.
 * The purpose of this class is to replace many small memory allocations
 * via malloc() with a few large ones.  Since the pages are never freed,
 * they can be re-used without having to re-allocate them.
 *
 * The settings *maxchunk*, *pagesize*, and *pagedelta* control
 * the memory allocation strategy.  The *maxchunk* value represents