aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/Opposite.h
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-01-07 09:34:21 +0000
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-01-07 09:34:21 +0000
commit8ba30554473ebcf3ac1c5a5e8b2139af0d730046 (patch)
treefb9dd10f5b7afb45217d15bb990750ad4f848a72 /Eigen/src/Core/Opposite.h
parent5111ace0d6ad7ceb505efbf7c591c23e8087ffa9 (diff)
Ready for alpha2 release.
- complete documentation - add TODO - update copyright years
Diffstat (limited to 'Eigen/src/Core/Opposite.h')
-rw-r--r--Eigen/src/Core/Opposite.h16
1 files changed, 15 insertions, 1 deletions
diff --git a/Eigen/src/Core/Opposite.h b/Eigen/src/Core/Opposite.h
index f1166be16..7f7aabd23 100644
--- a/Eigen/src/Core/Opposite.h
+++ b/Eigen/src/Core/Opposite.h
@@ -1,7 +1,7 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra. Eigen itself is part of the KDE project.
//
-// Copyright (C) 2006-2007 Benoit Jacob <jacob@math.jussieu.fr>
+// Copyright (C) 2006-2008 Benoit Jacob <jacob@math.jussieu.fr>
//
// Eigen is free software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
@@ -26,6 +26,18 @@
#ifndef EIGEN_OPPOSITE_H
#define EIGEN_OPPOSITE_H
+/** \class Opposite
+ *
+ * \brief Expression of the opposite of a matrix or vector
+ *
+ * \param MatrixType the type of which we are taking the opposite
+ *
+ * This class represents an expression of the opposite of a matrix or vector.
+ * It is the return type of the unary operator- for matrices or vectors, and most
+ * of the time this is the only way it is used.
+ *
+ * \sa class Difference
+ */
template<typename MatrixType> class Opposite : NoOperatorEquals,
public MatrixBase<typename MatrixType::Scalar, Opposite<MatrixType> >
{
@@ -53,6 +65,8 @@ template<typename MatrixType> class Opposite : NoOperatorEquals,
MatRef m_matrix;
};
+/** \returns an expression of the opposite of \c *this
+ */
template<typename Scalar, typename Derived>
const Opposite<Derived>
MatrixBase<Scalar, Derived>::operator-() const