aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2009-07-15 19:53:08 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2009-07-15 19:53:08 +0200
commit079fa81d84fc1efb3df784dc840f09b507db5536 (patch)
tree47d74b1d392d0df79e03873ddae37dff8a781203 /Eigen/src/Core
parent4f792583c76a693e0cd85048631eab21245b950b (diff)
add a TridiagonalMatrix wrapper arround BandMatrix, and extend this latter
Diffstat (limited to 'Eigen/src/Core')
-rw-r--r--Eigen/src/Core/BandMatrix.h64
1 files changed, 54 insertions, 10 deletions
diff --git a/Eigen/src/Core/BandMatrix.h b/Eigen/src/Core/BandMatrix.h
index aaf907593..8136724dd 100644
--- a/Eigen/src/Core/BandMatrix.h
+++ b/Eigen/src/Core/BandMatrix.h
@@ -28,11 +28,19 @@
/** \nonstableyet
* \class BandMatrix
*
- * \brief
+ * \brief Represents a rectangular matrix with a banded storage
*
- * \param
+ * \param _Scalar Numeric type, i.e. float, double, int
+ * \param Rows Number of rows, or \b Dynamic
+ * \param Cols Number of columns, or \b Dynamic
+ * \param Supers Number of super diagonal
+ * \param Subs Number of sub diagonal
+ * \param _Options A combination of either \b RowMajor or \b ColMajor, and of \b SelfAdjoint
+ * The former controls storage order, and defaults to column-major. The latter controls
+ * whether the matrix represent a selfadjoint matrix in which case either Supers of Subs
+ * have to be null.
*
- * \sa
+ * \sa class TridiagonalMatrix
*/
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
struct ei_traits<BandMatrix<_Scalar,Rows,Cols,Supers,Subs,Options> >
@@ -94,7 +102,8 @@ class BandMatrix : public MultiplierBase<BandMatrix<_Scalar,Rows,Cols,Supers,Sub
/** \returns the number of sub diagonals */
inline int subs() const { return m_subs.value(); }
- /** \returns a vector expression of the \a i -th column */
+ /** \returns a vector expression of the \a i -th column,
+ * only the meaningful part is returned */
inline Block<DataType,Dynamic,1> col(int i)
{
int j = i - (cols() - supers() + 1);
@@ -112,25 +121,31 @@ class BandMatrix : public MultiplierBase<BandMatrix<_Scalar,Rows,Cols,Supers,Sub
template<int Index> struct DiagonalIntReturnType {
enum {
+ ReturnOpposite = (Options&SelfAdjoint) && (Index>0 && Supers==0 || Index<0 && Subs==0),
+ Conjugate = ReturnOpposite && NumTraits<Scalar>::IsComplex,
+ ActualIndex = ReturnOpposite ? -Index : Index,
DiagonalSize = RowsAtCompileTime==Dynamic || ColsAtCompileTime==Dynamic
? Dynamic
- : Index<0
- ? EIGEN_ENUM_MIN(ColsAtCompileTime, RowsAtCompileTime + Index)
- : EIGEN_ENUM_MIN(RowsAtCompileTime, ColsAtCompileTime - Index)
+ : ActualIndex<0
+ ? EIGEN_ENUM_MIN(ColsAtCompileTime, RowsAtCompileTime + ActualIndex)
+ : EIGEN_ENUM_MIN(RowsAtCompileTime, ColsAtCompileTime - ActualIndex)
};
- typedef Block<DataType,1, DiagonalSize> Type;
+ typedef Block<DataType,1, DiagonalSize> BuildType;
+ typedef typename ei_meta_if<Conjugate,
+ CwiseUnaryOp<ei_scalar_conjugate_op<Scalar>,NestByValue<BuildType> >,
+ BuildType>::ret Type;
};
/** \returns a vector expression of the \a Index -th sub or super diagonal */
template<int Index> inline typename DiagonalIntReturnType<Index>::Type diagonal()
{
- return typename DiagonalIntReturnType<Index>::Type(m_data, supers()-Index, std::max(0,Index), 1, diagonalLength(Index));
+ return typename DiagonalIntReturnType<Index>::BuildType(m_data, supers()-Index, std::max(0,Index), 1, diagonalLength(Index));
}
/** \returns a vector expression of the \a Index -th sub or super diagonal */
template<int Index> inline const typename DiagonalIntReturnType<Index>::Type diagonal() const
{
- return typename DiagonalIntReturnType<Index>::Type(m_data, supers()-Index, std::max(0,Index), 1, diagonalLength(Index));
+ return typename DiagonalIntReturnType<Index>::BuildType(m_data, supers()-Index, std::max(0,Index), 1, diagonalLength(Index));
}
/** \returns a vector expression of the \a i -th sub or super diagonal */
@@ -171,4 +186,33 @@ class BandMatrix : public MultiplierBase<BandMatrix<_Scalar,Rows,Cols,Supers,Sub
ei_int_if_dynamic<Subs> m_subs;
};
+/** \nonstableyet
+ * \class TridiagonalMatrix
+ *
+ * \brief Represents a tridiagonal matrix
+ *
+ * \param _Scalar Numeric type, i.e. float, double, int
+ * \param Size Number of rows and cols, or \b Dynamic
+ * \param _Options Can be 0 or \b SelfAdjoint
+ *
+ * \sa class BandMatrix
+ */
+template<typename Scalar, int Size, int Options>
+class TridiagonalMatrix : public BandMatrix<Scalar,Size,Size,1,Options&SelfAdjoint?0:1,Options|RowMajor>
+{
+ typedef BandMatrix<Scalar,Size,Size,1,Options&SelfAdjoint?0:1,Options|RowMajor> Base;
+ public:
+ TridiagonalMatrix(int size = Size) : Base(size,size,1,1) {}
+
+ inline typename Base::template DiagonalIntReturnType<1>::Type super()
+ { return Base::template diagonal<1>(); }
+ inline const typename Base::template DiagonalIntReturnType<1>::Type super() const
+ { return Base::template diagonal<1>(); }
+ inline typename Base::template DiagonalIntReturnType<-1>::Type sub()
+ { return Base::template diagonal<-1>(); }
+ inline const typename Base::template DiagonalIntReturnType<-1>::Type sub() const
+ { return Base::template diagonal<-1>(); }
+ protected:
+};
+
#endif // EIGEN_BANDMATRIX_H