add javadoc

chocoteam · Aug 4, 2023 · 9e99bb2 · 9e99bb2
1 parent 1de7267
commit 9e99bb2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java b/solver/src/main/java/org/chocosolver/solver/constraints/IIntConstraintFactory.java
@@ -558,6 +558,14 @@ default Constraint pow(IntVar base, int exponent, IntVar result) {
         }
     }
 
+    /**
+     * <p>Creates a power constraint: X^Y = Z.</p>
+     *
+     * @param base     first variable
+     * @param exponent second variable
+     * @param result   result variable
+     * @implSpec The 'power' propagator does not exist. The general case is handled by a table decomposition.
+     */
     default Constraint pow(IntVar base, IntVar exponent, IntVar result) {
         if (exponent.isInstantiated()) {
             return pow(base, exponent.getValue(), result);