1c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This file is part of Eigen, a lightweight C++ template library 2c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// for linear algebra. 3c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 4c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr> 5c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com> 6c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 7c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This Source Code Form is subject to the terms of the Mozilla 8c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Public License v. 2.0. If a copy of the MPL was not distributed 9c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// with this file, You can obtain one at http://mozilla.org/MPL/2.0/. 10c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 11c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#ifndef EIGEN_COMMAINITIALIZER_H 12c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#define EIGEN_COMMAINITIALIZER_H 13c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 14c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathnamespace Eigen { 15c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 16c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \class CommaInitializer 17c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \ingroup Core_Module 18c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 19c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \brief Helper class used by the comma initializer operator 20c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 21c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * This class is internally used to implement the comma initializer feature. It is 22c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * the return type of MatrixBase::operator<<, and most of the time this is the only 23c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * way it is used. 24c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 25c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa \ref MatrixBaseCommaInitRef "MatrixBase::operator<<", CommaInitializer::finished() 26c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 27c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename XprType> 28c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathstruct CommaInitializer 29c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 30c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename XprType::Scalar Scalar; 31c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename XprType::Index Index; 32c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 33c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline CommaInitializer(XprType& xpr, const Scalar& s) 34c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1) 35c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 36c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_xpr.coeffRef(0,0) = s; 37c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 38c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 39c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<typename OtherDerived> 40c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline CommaInitializer(XprType& xpr, const DenseBase<OtherDerived>& other) 41c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows()) 42c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 43c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_xpr.block(0, 0, other.rows(), other.cols()) = other; 44c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 45c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 46c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /* inserts a scalar value in the target matrix */ 47c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath CommaInitializer& operator,(const Scalar& s) 48c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 49c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath if (m_col==m_xpr.cols()) 50c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 51c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_row+=m_currentBlockRows; 52c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_col = 0; 53c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_currentBlockRows = 1; 54c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_row<m_xpr.rows() 55c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && "Too many rows passed to comma initializer (operator<<)"); 56c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 57c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_col<m_xpr.cols() 58c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && "Too many coefficients passed to comma initializer (operator<<)"); 59c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_currentBlockRows==1); 60c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_xpr.coeffRef(m_row, m_col++) = s; 61c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return *this; 62c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 63c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 64c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /* inserts a matrix expression in the target matrix */ 65c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<typename OtherDerived> 66c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath CommaInitializer& operator,(const DenseBase<OtherDerived>& other) 67c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 68c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath if (m_col==m_xpr.cols()) 69c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 70c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_row+=m_currentBlockRows; 71c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_col = 0; 72c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_currentBlockRows = other.rows(); 73c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_row+m_currentBlockRows<=m_xpr.rows() 74c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && "Too many rows passed to comma initializer (operator<<)"); 75c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 76c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_col<m_xpr.cols() 77c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && "Too many coefficients passed to comma initializer (operator<<)"); 78c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert(m_currentBlockRows==other.rows()); 79c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath if (OtherDerived::SizeAtCompileTime != Dynamic) 80c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_xpr.template block<OtherDerived::RowsAtCompileTime != Dynamic ? OtherDerived::RowsAtCompileTime : 1, 81c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath OtherDerived::ColsAtCompileTime != Dynamic ? OtherDerived::ColsAtCompileTime : 1> 82c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath (m_row, m_col) = other; 83c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath else 84c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_xpr.block(m_row, m_col, other.rows(), other.cols()) = other; 85c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath m_col += other.cols(); 86c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return *this; 87c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 88c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 89c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline ~CommaInitializer() 90c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 91c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath eigen_assert((m_row+m_currentBlockRows) == m_xpr.rows() 92c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && m_col == m_xpr.cols() 93c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath && "Too few coefficients passed to comma initializer (operator<<)"); 94c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 95c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 96c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \returns the built matrix once all its coefficients have been set. 97c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Calling finished is 100% optional. Its purpose is to write expressions 98c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * like this: 99c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \code 100c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished()); 101c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \endcode 102c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 103c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline XprType& finished() { return m_xpr; } 104c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 105c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath XprType& m_xpr; // target expression 106c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Index m_row; // current row id 107c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Index m_col; // current col id 108c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Index m_currentBlockRows; // current block height 109c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath}; 110c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 111c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \anchor MatrixBaseCommaInitRef 112c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Convenient operator to set the coefficients of a matrix. 113c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 114c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * The coefficients must be provided in a row major order and exactly match 115c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * the size of the matrix. Otherwise an assertion is raised. 116c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 117c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Example: \include MatrixBase_set.cpp 118c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Output: \verbinclude MatrixBase_set.out 119c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 120c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa CommaInitializer::finished(), class CommaInitializer 121c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 122c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 123c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathinline CommaInitializer<Derived> DenseBase<Derived>::operator<< (const Scalar& s) 124c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 125c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return CommaInitializer<Derived>(*static_cast<Derived*>(this), s); 126c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 127c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 128c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \sa operator<<(const Scalar&) */ 129c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 130c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename OtherDerived> 131c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathinline CommaInitializer<Derived> 132c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathDenseBase<Derived>::operator<<(const DenseBase<OtherDerived>& other) 133c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 134c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return CommaInitializer<Derived>(*static_cast<Derived *>(this), other); 135c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 136c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 137c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} // end namespace Eigen 138c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 139c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#endif // EIGEN_COMMAINITIALIZER_H 140