[Bf-blender-cvs] [db06b3a0b49] functions: comment to note invariants of particle indices arrays

[Jacques Lucke]

Commit: db06b3a0b499956f1de8ea68230a2e88325ed9af
Author: Jacques Lucke
Date:   Fri Jun 21 14:14:34 2019 +0200
Branches: functions
https://developer.blender.org/rBdb06b3a0b499956f1de8ea68230a2e88325ed9af

comment to note invariants of particle indices arrays

===================================================================

M	source/blender/simulations/bparticles/core.hpp

===================================================================

diff --git a/source/blender/simulations/bparticles/core.hpp b/source/blender/simulations/bparticles/core.hpp
index be568c46797..d192b19cf25 100644
--- a/source/blender/simulations/bparticles/core.hpp
+++ b/source/blender/simulations/bparticles/core.hpp
@@ -28,6 +28,11 @@ using std::unique_ptr;
 struct ParticleSet {
  private:
   AttributeArrays m_attributes;
+
+  /* Indices into the attribute arrays.
+   * Invariants:
+   *   - Every index must exist at most once.
+   *   - The indices must be sorted. */
   ArrayRef<uint> m_particle_indices;
 
  public: