From 55a1de171b64b919a79dd7ce67447401d5e00805 Mon Sep 17 00:00:00 2001 From: MITSUNARI Shigeo Date: Tue, 13 Aug 2019 15:08:23 +0900 Subject: [PATCH] [doc] update getStr(mode) --- readme.md | 11 ++++++----- 1 file 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 ` ; not compressed format -* `2 ` ; compressed format for even y -* `3 ` ; compressed format for odd y +* `1 ` ; Affine coordinate with mode = `mcl:IoEcAffine` +* `4 ` ; jacobi/Proj coordinate with mode = `mcl::IoEcProj` +* `2 ` ; compressed format for even y with mode = `mcl::IoEcCompY` +* `3 ` ; compressed format for odd y with mode = `mcl::IoEcCompY` ## Generator of G1 and G2