From 46e0114326545a635f60f3e1832e1937cfe342b5 Mon Sep 17 00:00:00 2001 From: kylekatarnls Date: Sun, 10 Aug 2025 18:29:06 +0200 Subject: [PATCH] Document clamp function --- reference/math/functions/clamp.xml | 157 +++++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 reference/math/functions/clamp.xml diff --git a/reference/math/functions/clamp.xml b/reference/math/functions/clamp.xml new file mode 100644 index 0000000000..1f0c8867ac --- /dev/null +++ b/reference/math/functions/clamp.xml @@ -0,0 +1,157 @@ + + + + + + clamp + Retourne la valeur d'entrée si elle est comprise entre 2 bornes, sinon retourne la borne la plus proche + + + &reftitle.description; + + mixedclamp + mixedvalue + mixedmin + mixedmax + + + Retourne la valeur d'entrée si elle est comprise entre min et max. + Si elle est inférieur à min, retourne min. + Sinon retourne max. + + + + Les valeurs de différents types seront comparées en utilisant + les règles de + comparaison standard. Actuellement, une chaîne non numérique + sera comparée à un &integer;, comme s'il s'agissait de la valeur + 0, mais plusieurs &string; non-numérique seront comparées de façon + alphanumérique. La valeur actuelle retournée sera du même type que + l'original et aucune conversion de type ne sera appliquée. + + + + + Soyez prudent lorsque vous passez des arguments avec des types différents, + car clamp peut produire des résultats imprévisibles. + + + + + &reftitle.parameters; + + + + value + + + Toute valeur comparable à resserrer entre + min et max. + + + + + min + + + Une valeur minimum comparable + à laquelle contraindre value. + + + + + max + + + Une valeur maximum comparable + à laquelle contraindre value. + + + + + + + + &reftitle.returnvalues; + + La fonction clamp retourne le paramètre value + s'il est considéré comme "entre" min et max + suivant la comparaison standard. + Si plusieurs valeurs de types différents sont évaluées comme étant égales + (i.e. 0 et 'abc'), la première fournie + à la fonction sera retournée. + + + Si value est NAN, alors la valeur de retour + est également NAN. + + + + + &reftitle.errors; + + Si min est supérieur à max, + la fonction clamp lance une ValueError. + + + Si min ou max est NAN, + la fonction clamp lance une ValueError. + + + + + &reftitle.examples; + + + Exemple avec <function>clamp</function> + +format('Y-m-d'), PHP_EOL; // 2025-08-15 +?> +]]> + + + + + + + &reftitle.seealso; + + + min + max + + + + +