Skip to content

Commit a0c02ce

Browse files
authored
Fix typos in documentation and code comments (#225)
- Fix 'qudratic' to 'quadratic' in pyproject.toml keywords - Fix 'gauranteed' to 'guaranteed' in generic.py docstring - Fix 'conver' to 'convert' in generic.py comment - Remove commented-out dead code in generic.py
1 parent ba2ab64 commit a0c02ce

2 files changed

Lines changed: 3 additions & 4 deletions

File tree

procrustes/generic.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def generic(
5555
\underbrace{\text{min}}_{\mathbf{T}} \quad \|\mathbf{A} \mathbf{T} - \mathbf{B}\|_{F}^2
5656
5757
This Procrustes method requires the :math:`\mathbf{A}` and :math:`\mathbf{B}` matrices to
58-
have the same shape, which is gauranteed with the default ``pad`` argument for any given
58+
have the same shape, which is guaranteed with the default ``pad`` argument for any given
5959
:math:`\mathbf{A}` and :math:`\mathbf{B}` matrices. In preparing the :math:`\mathbf{A}` and
6060
:math:`\mathbf{B}` matrices, the (optional) order of operations is: **1)** unpad zero
6161
rows/columns, **2)** translate the matrices to the origin, **3)** weight entries of
@@ -124,11 +124,10 @@ def generic(
124124
a_inv = pinv(np.dot(new_a.T, new_a))
125125
# add little bit of random noise when the matrix is ill conditioned
126126
except np.linalg.LinAlgError:
127-
# conver new_a to float if it is not
127+
# convert new_a to float if it is not
128128
new_a = new_a.astype(float)
129129
new_a += 2e-14 * np.random.random_sample((new_a.shape[0], new_a.shape[1])) - 1e-14
130130
a_inv = pinv(np.dot(new_a.T, new_a))
131-
# a_inv = pinv(np.dot(new_a.T, new_a))
132131

133132
array_x = np.linalg.multi_dot([a_inv, new_a.T, new_b])
134133
# compute one-sided error

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ authors = [
3333
keywords = [
3434
"procrustes analysis",
3535
"statistical shape analysis",
36-
"qudratic assignment problem",
36+
"quadratic assignment problem",
3737
"matrix transformation",
3838
"generalized procrustes analysis",
3939
"orthogonal procrustes problem",

0 commit comments

Comments
 (0)