Main MRPT website > C++ reference
MRPT logo

CommaInitializer.h

Go to the documentation of this file.
00001 // This file is part of Eigen, a lightweight C++ template library
00002 // for linear algebra.
00003 //
00004 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
00005 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
00006 //
00007 // Eigen is free software; you can redistribute it and/or
00008 // modify it under the terms of the GNU Lesser General Public
00009 // License as published by the Free Software Foundation; either
00010 // version 3 of the License, or (at your option) any later version.
00011 //
00012 // Alternatively, you can redistribute it and/or
00013 // modify it under the terms of the GNU General Public License as
00014 // published by the Free Software Foundation; either version 2 of
00015 // the License, or (at your option) any later version.
00016 //
00017 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
00018 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00019 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
00020 // GNU General Public License for more details.
00021 //
00022 // You should have received a copy of the GNU Lesser General Public
00023 // License and a copy of the GNU General Public License along with
00024 // Eigen. If not, see <http://www.gnu.org/licenses/>.
00025 
00026 #ifndef EIGEN_COMMAINITIALIZER_H
00027 #define EIGEN_COMMAINITIALIZER_H
00028 
00029 /** \class CommaInitializer
00030   * \ingroup Core_Module
00031   *
00032   * \brief Helper class used by the comma initializer operator
00033   *
00034   * This class is internally used to implement the comma initializer feature. It is
00035   * the return type of MatrixBase::operator<<, and most of the time this is the only
00036   * way it is used.
00037   *
00038   * \sa \ref MatrixBaseCommaInitRef "MatrixBase::operator<<", CommaInitializer::finished()
00039   */
00040 template<typename XprType>
00041 struct CommaInitializer
00042 {
00043   typedef typename XprType::Scalar Scalar;
00044   typedef typename XprType::Index Index;
00045 
00046   inline CommaInitializer(XprType& xpr, const Scalar& s)
00047     : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1)
00048   {
00049     m_xpr.coeffRef(0,0) = s;
00050   }
00051 
00052   template<typename OtherDerived>
00053   inline CommaInitializer(XprType& xpr, const DenseBase<OtherDerived>& other)
00054     : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows())
00055   {
00056     m_xpr.block(0, 0, other.rows(), other.cols()) = other;
00057   }
00058 
00059   /* inserts a scalar value in the target matrix */
00060   CommaInitializer& operator,(const Scalar& s)
00061   {
00062     if (m_col==m_xpr.cols())
00063     {
00064       m_row+=m_currentBlockRows;
00065       m_col = 0;
00066       m_currentBlockRows = 1;
00067       eigen_assert(m_row<m_xpr.rows()
00068         && "Too many rows passed to comma initializer (operator<<)");
00069     }
00070     eigen_assert(m_col<m_xpr.cols()
00071       && "Too many coefficients passed to comma initializer (operator<<)");
00072     eigen_assert(m_currentBlockRows==1);
00073     m_xpr.coeffRef(m_row, m_col++) = s;
00074     return *this;
00075   }
00076 
00077   /* inserts a matrix expression in the target matrix */
00078   template<typename OtherDerived>
00079   CommaInitializer& operator,(const DenseBase<OtherDerived>& other)
00080   {
00081     if (m_col==m_xpr.cols())
00082     {
00083       m_row+=m_currentBlockRows;
00084       m_col = 0;
00085       m_currentBlockRows = other.rows();
00086       eigen_assert(m_row+m_currentBlockRows<=m_xpr.rows()
00087         && "Too many rows passed to comma initializer (operator<<)");
00088     }
00089     eigen_assert(m_col<m_xpr.cols()
00090       && "Too many coefficients passed to comma initializer (operator<<)");
00091     eigen_assert(m_currentBlockRows==other.rows());
00092     if (OtherDerived::SizeAtCompileTime != Dynamic)
00093       m_xpr.template block<OtherDerived::RowsAtCompileTime != Dynamic ? OtherDerived::RowsAtCompileTime : 1,
00094                               OtherDerived::ColsAtCompileTime != Dynamic ? OtherDerived::ColsAtCompileTime : 1>
00095                     (m_row, m_col) = other;
00096     else
00097       m_xpr.block(m_row, m_col, other.rows(), other.cols()) = other;
00098     m_col += other.cols();
00099     return *this;
00100   }
00101 
00102   inline ~CommaInitializer()
00103   {
00104     eigen_assert((m_row+m_currentBlockRows) == m_xpr.rows()
00105          && m_col == m_xpr.cols()
00106          && "Too few coefficients passed to comma initializer (operator<<)");
00107   }
00108 
00109   /** \returns the built matrix once all its coefficients have been set.
00110     * Calling finished is 100% optional. Its purpose is to write expressions
00111     * like this:
00112     * \code
00113     * quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished());
00114     * \endcode
00115     */
00116   inline XprType& finished() { return m_xpr; }
00117 
00118   XprType& m_xpr;   // target expression
00119   Index m_row;              // current row id
00120   Index m_col;              // current col id
00121   Index m_currentBlockRows; // current block height
00122 };
00123 
00124 /** \anchor MatrixBaseCommaInitRef
00125   * Convenient operator to set the coefficients of a matrix.
00126   *
00127   * The coefficients must be provided in a row major order and exactly match
00128   * the size of the matrix. Otherwise an assertion is raised.
00129   *
00130   * Example: \include MatrixBase_set.cpp
00131   * Output: \verbinclude MatrixBase_set.out
00132   *
00133   * \sa CommaInitializer::finished(), class CommaInitializer
00134   */
00135 template<typename Derived>
00136 inline CommaInitializer<Derived> DenseBase<Derived>::operator<< (const Scalar& s)
00137 {
00138   return CommaInitializer<Derived>(*static_cast<Derived*>(this), s);
00139 }
00140 
00141 /** \sa operator<<(const Scalar&) */
00142 template<typename Derived>
00143 template<typename OtherDerived>
00144 inline CommaInitializer<Derived>
00145 DenseBase<Derived>::operator<<(const DenseBase<OtherDerived>& other)
00146 {
00147   return CommaInitializer<Derived>(*static_cast<Derived *>(this), other);
00148 }
00149 
00150 #endif // EIGEN_COMMAINITIALIZER_H



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011