Skip to content

Commit 05d95f2

Browse files
committed
Docs
1 parent e96da5b commit 05d95f2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/sage/modules/free_module_integer.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -899,14 +899,20 @@ def babai(self, *args, **kwargs):
899899

900900
def hadamard_ratio(self, use_reduced_basis=True):
901901
"""
902-
Computes the normalized hadamard ratio. The closer this ratio is to 1,
903-
the more orthogonal the basis is.
902+
Computes the normalized Hadamard ratio of the given basis.
903+
904+
The normalized Hadamard ratio of the basis `B = \{v_1, v_2, \dots, v_n\} is defined as
905+
906+
.. MATH::
907+
\mathcal{H}(B) = \left(\dfrac{det L}{\|v_1\| \|v_2\| \cdots \|v_n\|}\right)^{\frac{1}{n}}
908+
909+
The closer this ratio is to 1, the more orthogonal the basis is.
904910
905911
INPUT:
906912
- ``use_reduced_basis`` -- boolean (default: ``True``); uses reduced basis
907913
for computing the ratio
908914
909-
OUTPUT: The normalized hadamard ratio. This ratio lies in (0, 1]
915+
OUTPUT: The normalized Hadamard ratio. This ratio lies in (0, 1]
910916
911917
EXAMPLES::
912918

0 commit comments

Comments
 (0)