[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Usata-commits] Changes to usata2/src/math/vector.hpp
From: |
Chong Kai Xiong |
Subject: |
[Usata-commits] Changes to usata2/src/math/vector.hpp |
Date: |
Tue, 04 Jan 2005 08:27:40 -0500 |
Index: usata2/src/math/vector.hpp
diff -u usata2/src/math/vector.hpp:1.6 usata2/src/math/vector.hpp:1.7
--- usata2/src/math/vector.hpp:1.6 Fri Dec 31 05:14:41 2004
+++ usata2/src/math/vector.hpp Tue Jan 4 13:15:56 2005
@@ -10,7 +10,7 @@
// included in the software distribution, or visit
// http://www.fsf.org/licenses/gpl.html.
//
-// $Id: vector.hpp,v 1.6 2004/12/31 05:14:41 Descender Exp $
+// $Id: vector.hpp,v 1.7 2005/01/04 13:15:56 Descender Exp $
#ifndef USATA_MATH_VECTOR_HPP
#define USATA_MATH_VECTOR_HPP
@@ -20,10 +20,15 @@
namespace usata
{
+ /*! \defgroup math Mathematics */
+
+ //! \brief Mathematical classes and functions
namespace math
{
+ //! \ingroup math
//! \brief Homogeneous 3D vector
+ //! \todo Convert to an expression template implementation.
//! \param T Component type.
template <typename T>
class Vector4
@@ -56,7 +61,8 @@
//! \brief Index operator
//! \param index Index of component.
- T
+ //! \return reference to component.
+ T&
operator[] (int index) const
{
return v[index];
@@ -210,6 +216,7 @@
//! \brief Returns dot product
//! \param[in] rhs Right operand.
+ //! \return Dot product.
T
dot(const Vector4& rhs) const
{
@@ -221,6 +228,7 @@
//! \brief Returns cross product
//! \param[in] rhs Right operand.
+ //! \return Cross product.
T
cross(const Vector4& rhs) const
{
@@ -242,6 +250,7 @@
}
//! \brief Returns magnitude
+ //! \return Magnitude.
T
length() const
{
- [Usata-commits] Changes to usata2/src/math/vector.hpp,
Chong Kai Xiong <=