Skip to content

Commit c005e35

Browse files
authored
Fixed typos in ImathVec documentation of equalWithAbs/RelError functions (AcademySoftwareFoundation#512)
Signed-off-by: romainaugier <augier.romain@sfr.fr>
1 parent 030e5c0 commit c005e35

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

src/Imath/ImathVec.h

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -192,19 +192,19 @@ template <class T> class IMATH_EXPORT_TEMPLATE_TYPE Vec2
192192
IMATH_HOSTDEVICE constexpr bool
193193
operator!= (const Vec2<S>& v) const IMATH_NOEXCEPT;
194194

195-
/// Compare two matrices and test if they are "approximately equal":
196-
/// @return True if the coefficients of this and `m` are the same
197-
/// with an absolute error of no more than e, i.e., for all i, j:
195+
/// Compare two vectors and test if they are "approximately equal":
196+
/// @return True if the components of this and `v` are the same
197+
/// with an absolute error of no more than e, i.e., for all i:
198198
///
199-
/// abs (this[i][j] - m[i][j]) <= e
199+
/// abs (this[i] - v[i]) <= e
200200
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
201201
equalWithAbsError (const Vec2<T>& v, T e) const IMATH_NOEXCEPT;
202202

203-
/// Compare two matrices and test if they are "approximately equal":
204-
/// @return True if the coefficients of this and m are the same with
205-
/// a relative error of no more than e, i.e., for all i, j:
203+
/// Compare two vectors and test if they are "approximately equal":
204+
/// @return True if the components of this and `v` are the same with
205+
/// a relative error of no more than e, i.e., for all i:
206206
///
207-
/// abs (this[i] - v[i][j]) <= e * abs (this[i][j])
207+
/// abs (this[i] - v[i]) <= e * abs (this[i])
208208
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
209209
equalWithRelError (const Vec2<T>& v, T e) const IMATH_NOEXCEPT;
210210

@@ -521,19 +521,19 @@ template <class T> class IMATH_EXPORT_TEMPLATE_TYPE Vec3
521521
IMATH_HOSTDEVICE constexpr bool
522522
operator!= (const Vec3<S>& v) const IMATH_NOEXCEPT;
523523

524-
/// Compare two matrices and test if they are "approximately equal":
525-
/// @return True if the coefficients of this and `m` are the same
526-
/// with an absolute error of no more than e, i.e., for all i, j:
524+
/// Compare two vectors and test if they are "approximately equal":
525+
/// @return True if the components of this and `v` are the same
526+
/// with an absolute error of no more than e, i.e., for all i:
527527
///
528-
/// abs (this[i][j] - m[i][j]) <= e
528+
/// abs (this[i] - v[i]) <= e
529529
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
530530
equalWithAbsError (const Vec3<T>& v, T e) const IMATH_NOEXCEPT;
531531

532-
/// Compare two matrices and test if they are "approximately equal":
533-
/// @return True if the coefficients of this and m are the same with
534-
/// a relative error of no more than e, i.e., for all i, j:
532+
/// Compare two vectors and test if they are "approximately equal":
533+
/// @return True if the components of this and `v` are the same with
534+
/// a relative error of no more than e, i.e., for all i:
535535
///
536-
/// abs (this[i] - v[i][j]) <= e * abs (this[i][j])
536+
/// abs (this[i] - v[i]) <= e * abs (this[i])
537537
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
538538
equalWithRelError (const Vec3<T>& v, T e) const IMATH_NOEXCEPT;
539539

@@ -846,19 +846,19 @@ template <class T> class IMATH_EXPORT_TEMPLATE_TYPE Vec4
846846
IMATH_HOSTDEVICE constexpr bool
847847
operator!= (const Vec4<S>& v) const IMATH_NOEXCEPT;
848848

849-
/// Compare two matrices and test if they are "approximately equal":
850-
/// @return True if the coefficients of this and `m` are the same
851-
/// with an absolute error of no more than e, i.e., for all i, j:
849+
/// Compare two vectors and test if they are "approximately equal":
850+
/// @return True if the components of this and `v` are the same
851+
/// with an absolute error of no more than e, i.e., for all i:
852852
///
853-
/// abs (this[i][j] - m[i][j]) <= e
853+
/// abs (this[i] - v[i]) <= e
854854
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
855855
equalWithAbsError (const Vec4<T>& v, T e) const IMATH_NOEXCEPT;
856856

857-
/// Compare two matrices and test if they are "approximately equal":
858-
/// @return True if the coefficients of this and m are the same with
859-
/// a relative error of no more than e, i.e., for all i, j:
857+
/// Compare two vectors and test if they are "approximately equal":
858+
/// @return True if the components of this and `v` are the same with
859+
/// a relative error of no more than e, i.e., for all i:
860860
///
861-
/// abs (this[i] - v[i][j]) <= e * abs (this[i][j])
861+
/// abs (this[i] - v[i]) <= e * abs (this[i])
862862
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool
863863
equalWithRelError (const Vec4<T>& v, T e) const IMATH_NOEXCEPT;
864864

0 commit comments

Comments
 (0)