Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation typos #392

Open
keatsandyeats opened this issue Feb 11, 2021 · 1 comment
Open

Documentation typos #392

keatsandyeats opened this issue Feb 11, 2021 · 1 comment

Comments

@keatsandyeats
Copy link

The documentation for Clifford.Layout mixes up "inner" and "outer" to describe the tables produced by omt and imt. Here the one for the outer product says "inner" where it should say "outer":

def omt(self):
""" Multiplication table for the inner product, stored in the same way as :attr:`gmt` """
return construct_graded_mt(self._basis_blade_order, self.gmt, omt_check)

And here the one for the inner product says "outer" where it should say "inner":
def imt(self):
""" Multiplication table for the outer product, stored in the same way as :attr:`gmt` """
return construct_graded_mt(self._basis_blade_order, self.gmt, imt_check)


The documentation for Clifford.Multivector doesn't describe the commutator properly. It shows "+" where it should be "-":

def commutator(self, other) -> 'MultiVector':
r"""The commutator product of two multivectors.
:math:`[M, N] = M \times N = (MN + NM)/2`
"""
return ((self * other) - (other * self)) / 2

@eric-wieser
Copy link
Member

Whoops, good catch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants