[doc] add comments for mulByCofactorBLS12

5 years ago · f796b73629
parent a549f8dbdc
commit f796b73629
1 changed files with 2 additions and 1 deletions
--- a/api.md
+++ b/api.md
@ -18,7 +18,8 @@ The map-to-G2 function if `mode = MCL_MAP_TO_MODE_ETH2`.
 void mclBn_setOriginalG2cofactor(int enable);
 ```
 Use faster multiplication of `G2` with cofactor if `enable = 1`.
-This is disabled if `mclBn_setMapToMode(MCL_MAP_TO_MODE_ETH2)`.
+This is enabled if `mclBn_setMapToMode(MCL_MAP_TO_MODE_ETH2)`.
+if `enable = 0`, then [the fast algorithm (mulByCofactorBLS12)](https://github.com/herumi/mcl/blob/master/include/mcl/bn.hpp#L463) is used.

 ## Minimum sample