From c6bce64af34b3c410459f33380d1f1e388b8908f Mon Sep 17 00:00:00 2001 From: Danny Robson Date: Thu, 30 Jan 2020 15:06:36 +1100 Subject: [PATCH] quaternion: clarify that `from_to` result is normalised --- quaternion.hpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/quaternion.hpp b/quaternion.hpp index 1d89a016..fc2a67da 100644 --- a/quaternion.hpp +++ b/quaternion.hpp @@ -46,6 +46,8 @@ namespace cruft { /// Constructs a quaternion that represents the rotation of a unit /// vector `a` to the unit vector `b`. + /// + /// The return value is guaranteed to be normalised. static quaternion from_to (vector<3,T> a, vector<3,T> b); /// Constructs a quaternion that represents the rotation needed to