aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMITSUNARI Shigeo <herumi@nifty.com>2019-08-13 14:08:23 +0800
committerMITSUNARI Shigeo <herumi@nifty.com>2019-08-13 14:08:23 +0800
commit55a1de171b64b919a79dd7ce67447401d5e00805 (patch)
tree6ee29d852d427122fa0c26abc452a485d163318a
parent0a638c7ad2c25a45a257691031e3a694d47261f1 (diff)
downloadtangerine-mcl-55a1de171b64b919a79dd7ce67447401d5e00805.tar.gz
tangerine-mcl-55a1de171b64b919a79dd7ce67447401d5e00805.tar.zst
tangerine-mcl-55a1de171b64b919a79dd7ce67447401d5e00805.zip
[doc] update getStr(mode)
-rw-r--r--readme.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index 0510f1f..5efa874 100644
--- a/readme.md
+++ b/readme.md
@@ -358,14 +358,15 @@ These functions maps x into Gi according to [\[_Faster hashing to G2_\]].
## String format of G1 and G2
G1 and G2 have three elements of Fp (x, y, z) for Jacobi coordinate.
-normalize() method normalizes it to affine coordinate (x, y, 1) or (0, 0, 0).
+`normalize()` method normalizes it to affine coordinate (x, y, 1) or (0, 0, 0).
-getStr() method gets
+getStr(mode = 0) method gets
* `0` ; infinity
-* `1 <x> <y>` ; not compressed format
-* `2 <x>` ; compressed format for even y
-* `3 <x>` ; compressed format for odd y
+* `1 <x> <y>` ; Affine coordinate with mode = `mcl:IoEcAffine`
+* `4 <x> <y> <z>` ; jacobi/Proj coordinate with mode = `mcl::IoEcProj`
+* `2 <x>` ; compressed format for even y with mode = `mcl::IoEcCompY`
+* `3 <x>` ; compressed format for odd y with mode = `mcl::IoEcCompY`
## Generator of G1 and G2