feat: Allow one-sided multilayer relax limit

Closes #68

Author: danieledler

src/io/Config.cpp

@@ -181,13 +181,19 @@ Config Config::fromString(std::string flags, bool requireFileInput)
 			"Optimize for the preferred number of modules by penalizing solutions the more they differ from the preferred number.", "n", "Algorithm", true);
 
 	api.addOptionArgument(conf.multilayerRelaxRate, "multilayer-relax-rate",
-			"The probability to relax the constraint to move only in the current layer. If negative, the inter-links have to be provided.", "f", "Algorithm", true);
+			"The probability to relax the constraint to move only in the current layer. Default 0.15", "f", "Algorithm", true);
 
 	api.addOptionArgument(conf.multilayerRelaxLimit, "multilayer-relax-limit",
 			"The number of neighboring layers in each direction to relax to. If negative, relax to any layer.", "n", "Algorithm", true);
 
+	api.addOptionArgument(conf.multilayerRelaxLimitUp, "multilayer-relax-limit-up",
+			"The number of neighboring layers with higher id to relax to. If negative, relax to any layer.", "n", "Algorithm", true);
+
+	api.addOptionArgument(conf.multilayerRelaxLimitDown, "multilayer-relax-limit-down",
+			"The number of neighboring layers with lower id to relax to. If negative, relax to any layer.", "n", "Algorithm", true);
+
 	api.addOptionArgument(conf.multilayerJSRelaxRate, "multilayer-js-relax-rate",
-			"The probability to relax the constraint to move only in the current layer and instead move to a random layer where the same physical node is present and proportional to the out-link similarity measured by the Jensen-Shannon divergence. If negative, the inter-links have to be provided.", "f", "Algorithm", true);
+			"The probability to relax the constraint to move only in the current layer and instead move to a random layer where the same physical node is present and proportional to the out-link similarity measured by the Jensen-Shannon divergence. Default 0.15", "f", "Algorithm", true);
 
 	api.addOptionArgument(conf.multilayerJSRelaxLimit, "multilayer-js-relax-limit",
 			"The minimum out-link similarity measured by the Jensen-Shannon divergence to relax to other layer. From 0 to 1. No limit if negative.", "f", "Algorithm", true);

src/io/Config.h

@@ -114,7 +114,9 @@ struct Config
 	double selfTeleportationProbability = -1;
 	double markovTime = 1.0;
 	double multilayerRelaxRate = 0.15;
-	int multilayerRelaxLimit = -1;
+	int multilayerRelaxLimit = -1; // Amount of layers allowed to jump up or down
+	int multilayerRelaxLimitUp = -1; // One-sided limit to higher layers
+	int multilayerRelaxLimitDown = -1; // One-sided limit to lower layers
 	double multilayerJSRelaxRate = 0.15;
 	int multilayerJSRelaxLimit = -1;
 
@@ -228,6 +230,8 @@ struct Config
 		markovTime(other.markovTime),
 		multilayerRelaxRate(other.multilayerRelaxRate),
 		multilayerRelaxLimit(other.multilayerRelaxLimit),
+		multilayerRelaxLimitUp(other.multilayerRelaxLimitUp),
+		multilayerRelaxLimitDown(other.multilayerRelaxLimitDown),
 		multilayerJSRelaxRate(other.multilayerJSRelaxRate),
 		multilayerJSRelaxLimit(other.multilayerJSRelaxLimit),
 	 	twoLevel(other.twoLevel),
@@ -326,6 +330,8 @@ struct Config
 	 	markovTime = other.markovTime;
 		multilayerRelaxRate = other.multilayerRelaxRate;
 		multilayerRelaxLimit = other.multilayerRelaxLimit;
+		multilayerRelaxLimitUp = other.multilayerRelaxLimitUp;
+		multilayerRelaxLimitDown = other.multilayerRelaxLimitDown;
 		multilayerJSRelaxRate = other.multilayerJSRelaxRate;
 		multilayerJSRelaxLimit = other.multilayerJSRelaxLimit;
 	 	twoLevel = other.twoLevel;
@@ -423,6 +429,8 @@ struct Config
 	 	markovTime = other.markovTime;
 		multilayerRelaxRate = other.multilayerRelaxRate;
 		multilayerRelaxLimit = other.multilayerRelaxLimit;
+		multilayerRelaxLimitUp = other.multilayerRelaxLimitUp;
+		multilayerRelaxLimitDown = other.multilayerRelaxLimitDown;
 		multilayerJSRelaxRate = other.multilayerJSRelaxRate;
 		multilayerJSRelaxLimit = other.multilayerJSRelaxLimit;
 	 	twoLevel = other.twoLevel;
@@ -608,7 +616,7 @@ struct Config
 	// bool printAsUndirected() const { return originallyUndirected; }
 	bool printAsUndirected() const { return isUndirectedClustering(); }
 
-	bool useTeleportation() const { return 	directed; }
+	// bool useTeleportation() const { return 	directed; }
 
 	bool is3gram() const { return inputFormat == "3gram"; }
 	bool isPath() const { return inputFormat == "path"; }

src/io/Network.cpp

@@ -827,11 +827,24 @@ void Network::generateStateNetworkFromMultilayerWithSimulatedInterLinks()
 	Log() << "Generating state network from multilayer networks with simulated inter-layer links...\n" << std::flush;
 	double relaxRate = m_config.multilayerRelaxRate;
 
+	int maxRelaxLimit = m_networks.size();
+	int relaxLimitSymmetric = m_config.multilayerRelaxLimit < 0 ? maxRelaxLimit : m_config.multilayerRelaxLimit;
+	int relaxLimitDown = m_config.multilayerRelaxLimitDown < 0 ? relaxLimitSymmetric : std::min(relaxLimitSymmetric, m_config.multilayerRelaxLimitDown);
+	int relaxLimitUp = m_config.multilayerRelaxLimitUp < 0 ? relaxLimitSymmetric : std::min(relaxLimitSymmetric, m_config.multilayerRelaxLimitUp);
+	auto haveUpOrDownLimit = m_config.multilayerRelaxLimitDown >= 0 || m_config.multilayerRelaxLimitUp >= 0;
+
 	Log() << "-> " << m_networks.size() << " networks\n";
 	Log() << "-> Relax rate: " << relaxRate << "\n";
+	if (haveUpOrDownLimit) {
+		Log() << "-> Relax limit up: " << relaxLimitUp << (relaxLimitUp == maxRelaxLimit ? " (no limit)\n" : "\n");
+		Log() << "-> Relax limit down: " << relaxLimitDown << (relaxLimitDown == maxRelaxLimit ? " (no limit)\n" : "\n");
+	} else if (m_config.multilayerRelaxLimit >= 0) {
+		Log() << "-> Relax limit: " << m_config.multilayerRelaxLimit << "\n";
+	}
 
-	auto withinRelaxLimit = [](auto& a, auto& b, auto& limit) {
-		return limit < 0 || (a >= b ? (a - b) : (b - a)) <= (unsigned int)limit;
+	auto withinRelaxLimit = [relaxLimitDown, relaxLimitUp](auto& layer1, auto& layer2) {
+		int diff = layer1 - layer2;
+		return layer1 >= layer2 ? diff <= relaxLimitDown : -diff <= relaxLimitUp;
 	};
 
 	for (auto& it1 : m_networks) {
@@ -849,7 +862,7 @@ void Network::generateStateNetworkFromMultilayerWithSimulatedInterLinks()
 
 			for (auto& it2 : m_networks) {
 				auto layer2 = it2.first;
-				if (!withinRelaxLimit(layer1, layer2, m_config.multilayerRelaxLimit)) {
+				if (!withinRelaxLimit(layer1, layer2)) {
 					continue;
 				}
 				auto& network2 = it2.second;
@@ -862,7 +875,7 @@ void Network::generateStateNetworkFromMultilayerWithSimulatedInterLinks()
 			}
 			for (auto& it2 : m_networks) {
 				auto layer2 = it2.first;
-				if (!withinRelaxLimit(layer1, layer2, m_config.multilayerRelaxLimit)) {
+				if (!withinRelaxLimit(layer1, layer2)) {
 					continue;
 				}
 				auto& network2 = it2.second;

src/io/version.cpp

@@ -29,6 +29,6 @@
 
 namespace infomap {
 
-const char* INFOMAP_VERSION = "1.0.0-beta.56";
+const char* INFOMAP_VERSION = "1.0.0-beta.57";
 
 }