From f290a3b4412dc76e5fc6e617bd41180f3ae50e20 Mon Sep 17 00:00:00 2001
From: Stephan Schulz <stephan.schulz-x2q@rub.de>
Date: Tue, 24 Nov 2020 09:10:26 +0100
Subject: [PATCH] document histogram setMethodData (#22)
---
include/ALL.hpp | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/ALL.hpp b/include/ALL.hpp
index ca394f3..3934338 100644
--- a/include/ALL.hpp
+++ b/include/ALL.hpp
@@ -498,6 +498,10 @@ public:
/// balancing methods
/// @param[in] data pointer to a struct or other data object in the format the
/// methods requires
+ ///
+ /// For the histogram method the number of bins per dimensions can be given
+ /// as a C array of `int`s. The length of the array must be the number of
+ /// dimensions given to the load balancer. BE CAREFUL this is not enforced!
void setMethodData(const void *data) {
balancer.get()->setAdditionalData(data);
}
--
GitLab