diff --git a/docs/src/10-interface.md b/docs/src/10-interface.md index 404e42a..3754c99 100644 --- a/docs/src/10-interface.md +++ b/docs/src/10-interface.md @@ -64,4 +64,16 @@ The methods that returns the coordinates of the prefered system (returned by `co | `LorentzVectorBase.spatial_magnitude2(::MyType{MyLorentzVector})` | mass to the square | | Any of the above method i.e, a method of option Y when methods of option X are provided || -======= +## LorentzVectorBase + +The type can *optionnally* be a subtype of the LorentzVectorBase.LorentzVectorBase to benefit from default implementations of lorentz vector algebra. + +# Basic functions provided for subtypes of LorentzVectorBase + +- Base.+(::LorentzVectorBase, ::LorentzVectorBase) +- Base.-(::LorentzVectorBase, ::LorentzVectorBase) +- LinearAlgebra.dot(::LorentzVectorBase, ::LorentzVectorBase)¹ + +--- +¹x⋅y = LinearAlgebra.dot(x,y) +