From 336a1a4defa1521f4865a3b252b4d5f559f0d39d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nathan=20R=C3=A9biscoul?= <nathan.rebiscoul38@gmail.com>
Date: Fri, 5 Jul 2019 17:11:33 +0200
Subject: [PATCH] Add comment for udg_linear
---
tools/graphgen/graphGen_arg.ml | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/tools/graphgen/graphGen_arg.ml b/tools/graphgen/graphGen_arg.ml
index 6fc6f13e..1319b633 100644
--- a/tools/graphgen/graphGen_arg.ml
+++ b/tools/graphgen/graphGen_arg.ml
@@ -257,8 +257,16 @@ let (mkoptab : string array -> t -> unit) =
mkopt args ["--progressive-prob";"-pp"]
(Arg.Unit (fun () -> args.udg.proba <- LinearP))
- [(["...";"...";"...\n"], "UDG")];
+ [(["Uses a probability function for UDG that change probabilty according to the distance from the center,";
+ "using a linear function. Lower the distance is, greater the probability is.";
+ "This probability function will be used to know if an edge will be created when";
+ "two Unit Discs touch each other.\n"
+ ], "UDG")];
+ (** [linear_proba r] gives a function that, for an input d (distance) outputs d/r.
+ If r is the Unit Disc radius and d the distance between two points,
+ it outputs a probability that is higher for a low d and lower for a high d. *)
+
mkopt args ["--dot_udg";"-du"]~arg:" <file-base-name>"
(Arg.String (fun f -> match args.action with
| "UDG" -> args.dotUDG <- f
--
GitLab