Skip to content

Commit 715887e

Browse files
committed
Doc update
1 parent b7b9385 commit 715887e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/sage/modules/free_module_integer.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -909,6 +909,12 @@ def hadamard_ratio(self, use_reduced_basis=True):
909909
910910
The closer this ratio is to 1, the more orthogonal the basis is.
911911
912+
INPUT:
913+
- ``use_reduced_basis`` -- boolean (default: ``True``); uses reduced basis
914+
for computing the ratio
915+
916+
OUTPUT: The normalized Hadamard ratio. This ratio lies in (0, 1]
917+
912918
EXAMPLES::
913919
914920
sage: from sage.modules.free_module_integer import IntegerLattice
@@ -942,6 +948,12 @@ def gaussian_heuristic(self, exact_form=False):
942948
heuristic. This estimates the expected norm of the shortest non-zero vector
943949
in the lattice. The heuristic is independent of the chosen basis.
944950
951+
INPUT:
952+
- ``exact_form`` -- boolean (default: ``False``); uses exact formulation
953+
based on gamma function, instead of estimation of the gamma function
954+
955+
OUTPUT: The Gaussian heuristic described above.
956+
945957
EXAMPLES::
946958
947959
sage: from sage.modules.free_module_integer import IntegerLattice

0 commit comments

Comments
 (0)