block.cpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  1. // This file is part of Eigen, a lightweight C++ template library
  2. // for linear algebra.
  3. //
  4. // Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
  5. //
  6. // This Source Code Form is subject to the terms of the Mozilla
  7. // Public License v. 2.0. If a copy of the MPL was not distributed
  8. // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  9. #define EIGEN_NO_STATIC_ASSERT // otherwise we fail at compile time on unused paths
  10. #include "main.h"
  11. template<typename MatrixType, typename Index, typename Scalar>
  12. typename Eigen::internal::enable_if<!NumTraits<typename MatrixType::Scalar>::IsComplex,typename MatrixType::Scalar>::type
  13. block_real_only(const MatrixType &m1, Index r1, Index r2, Index c1, Index c2, const Scalar& s1) {
  14. // check cwise-Functions:
  15. VERIFY_IS_APPROX(m1.row(r1).cwiseMax(s1), m1.cwiseMax(s1).row(r1));
  16. VERIFY_IS_APPROX(m1.col(c1).cwiseMin(s1), m1.cwiseMin(s1).col(c1));
  17. VERIFY_IS_APPROX(m1.block(r1,c1,r2-r1+1,c2-c1+1).cwiseMin(s1), m1.cwiseMin(s1).block(r1,c1,r2-r1+1,c2-c1+1));
  18. VERIFY_IS_APPROX(m1.block(r1,c1,r2-r1+1,c2-c1+1).cwiseMax(s1), m1.cwiseMax(s1).block(r1,c1,r2-r1+1,c2-c1+1));
  19. return Scalar(0);
  20. }
  21. template<typename MatrixType, typename Index, typename Scalar>
  22. typename Eigen::internal::enable_if<NumTraits<typename MatrixType::Scalar>::IsComplex,typename MatrixType::Scalar>::type
  23. block_real_only(const MatrixType &, Index, Index, Index, Index, const Scalar&) {
  24. return Scalar(0);
  25. }
  26. // Check at compile-time that T1==T2, and at runtime-time that a==b
  27. template<typename T1,typename T2>
  28. typename internal::enable_if<internal::is_same<T1,T2>::value,bool>::type
  29. is_same_block(const T1& a, const T2& b)
  30. {
  31. return a.isApprox(b);
  32. }
  33. template<typename MatrixType> void block(const MatrixType& m)
  34. {
  35. typedef typename MatrixType::Scalar Scalar;
  36. typedef typename MatrixType::RealScalar RealScalar;
  37. typedef Matrix<Scalar, MatrixType::RowsAtCompileTime, 1> VectorType;
  38. typedef Matrix<Scalar, 1, MatrixType::ColsAtCompileTime> RowVectorType;
  39. typedef Matrix<Scalar, Dynamic, Dynamic, MatrixType::IsRowMajor?RowMajor:ColMajor> DynamicMatrixType;
  40. typedef Matrix<Scalar, Dynamic, 1> DynamicVectorType;
  41. Index rows = m.rows();
  42. Index cols = m.cols();
  43. MatrixType m1 = MatrixType::Random(rows, cols),
  44. m1_copy = m1,
  45. m2 = MatrixType::Random(rows, cols),
  46. m3(rows, cols),
  47. ones = MatrixType::Ones(rows, cols);
  48. VectorType v1 = VectorType::Random(rows);
  49. Scalar s1 = internal::random<Scalar>();
  50. Index r1 = internal::random<Index>(0,rows-1);
  51. Index r2 = internal::random<Index>(r1,rows-1);
  52. Index c1 = internal::random<Index>(0,cols-1);
  53. Index c2 = internal::random<Index>(c1,cols-1);
  54. block_real_only(m1, r1, r2, c1, c1, s1);
  55. //check row() and col()
  56. VERIFY_IS_EQUAL(m1.col(c1).transpose(), m1.transpose().row(c1));
  57. //check operator(), both constant and non-constant, on row() and col()
  58. m1 = m1_copy;
  59. m1.row(r1) += s1 * m1_copy.row(r2);
  60. VERIFY_IS_APPROX(m1.row(r1), m1_copy.row(r1) + s1 * m1_copy.row(r2));
  61. // check nested block xpr on lhs
  62. m1.row(r1).row(0) += s1 * m1_copy.row(r2);
  63. VERIFY_IS_APPROX(m1.row(r1), m1_copy.row(r1) + Scalar(2) * s1 * m1_copy.row(r2));
  64. m1 = m1_copy;
  65. m1.col(c1) += s1 * m1_copy.col(c2);
  66. VERIFY_IS_APPROX(m1.col(c1), m1_copy.col(c1) + s1 * m1_copy.col(c2));
  67. m1.col(c1).col(0) += s1 * m1_copy.col(c2);
  68. VERIFY_IS_APPROX(m1.col(c1), m1_copy.col(c1) + Scalar(2) * s1 * m1_copy.col(c2));
  69. //check block()
  70. Matrix<Scalar,Dynamic,Dynamic> b1(1,1); b1(0,0) = m1(r1,c1);
  71. RowVectorType br1(m1.block(r1,0,1,cols));
  72. VectorType bc1(m1.block(0,c1,rows,1));
  73. VERIFY_IS_EQUAL(b1, m1.block(r1,c1,1,1));
  74. VERIFY_IS_EQUAL(m1.row(r1), br1);
  75. VERIFY_IS_EQUAL(m1.col(c1), bc1);
  76. //check operator(), both constant and non-constant, on block()
  77. m1.block(r1,c1,r2-r1+1,c2-c1+1) = s1 * m2.block(0, 0, r2-r1+1,c2-c1+1);
  78. m1.block(r1,c1,r2-r1+1,c2-c1+1)(r2-r1,c2-c1) = m2.block(0, 0, r2-r1+1,c2-c1+1)(0,0);
  79. const Index BlockRows = 2;
  80. const Index BlockCols = 5;
  81. if (rows>=5 && cols>=8)
  82. {
  83. // test fixed block() as lvalue
  84. m1.template block<BlockRows,BlockCols>(1,1) *= s1;
  85. // test operator() on fixed block() both as constant and non-constant
  86. m1.template block<BlockRows,BlockCols>(1,1)(0, 3) = m1.template block<2,5>(1,1)(1,2);
  87. // check that fixed block() and block() agree
  88. Matrix<Scalar,Dynamic,Dynamic> b = m1.template block<BlockRows,BlockCols>(3,3);
  89. VERIFY_IS_EQUAL(b, m1.block(3,3,BlockRows,BlockCols));
  90. // same tests with mixed fixed/dynamic size
  91. m1.template block<BlockRows,Dynamic>(1,1,BlockRows,BlockCols) *= s1;
  92. m1.template block<BlockRows,Dynamic>(1,1,BlockRows,BlockCols)(0,3) = m1.template block<2,5>(1,1)(1,2);
  93. Matrix<Scalar,Dynamic,Dynamic> b2 = m1.template block<Dynamic,BlockCols>(3,3,2,5);
  94. VERIFY_IS_EQUAL(b2, m1.block(3,3,BlockRows,BlockCols));
  95. VERIFY(is_same_block(m1.block(3,3,BlockRows,BlockCols), m1.block(3,3,fix<Dynamic>(BlockRows),fix<Dynamic>(BlockCols))));
  96. VERIFY(is_same_block(m1.template block<BlockRows,Dynamic>(1,1,BlockRows,BlockCols), m1.block(1,1,fix<BlockRows>,BlockCols)));
  97. VERIFY(is_same_block(m1.template block<BlockRows,BlockCols>(1,1,BlockRows,BlockCols), m1.block(1,1,fix<BlockRows>(),fix<BlockCols>)));
  98. VERIFY(is_same_block(m1.template block<BlockRows,BlockCols>(1,1,BlockRows,BlockCols), m1.block(1,1,fix<BlockRows>,fix<BlockCols>(BlockCols))));
  99. }
  100. if (rows>2)
  101. {
  102. // test sub vectors
  103. VERIFY_IS_EQUAL(v1.template head<2>(), v1.block(0,0,2,1));
  104. VERIFY_IS_EQUAL(v1.template head<2>(), v1.head(2));
  105. VERIFY_IS_EQUAL(v1.template head<2>(), v1.segment(0,2));
  106. VERIFY_IS_EQUAL(v1.template head<2>(), v1.template segment<2>(0));
  107. Index i = rows-2;
  108. VERIFY_IS_EQUAL(v1.template tail<2>(), v1.block(i,0,2,1));
  109. VERIFY_IS_EQUAL(v1.template tail<2>(), v1.tail(2));
  110. VERIFY_IS_EQUAL(v1.template tail<2>(), v1.segment(i,2));
  111. VERIFY_IS_EQUAL(v1.template tail<2>(), v1.template segment<2>(i));
  112. i = internal::random<Index>(0,rows-2);
  113. VERIFY_IS_EQUAL(v1.segment(i,2), v1.template segment<2>(i));
  114. }
  115. // stress some basic stuffs with block matrices
  116. VERIFY(numext::real(ones.col(c1).sum()) == RealScalar(rows));
  117. VERIFY(numext::real(ones.row(r1).sum()) == RealScalar(cols));
  118. VERIFY(numext::real(ones.col(c1).dot(ones.col(c2))) == RealScalar(rows));
  119. VERIFY(numext::real(ones.row(r1).dot(ones.row(r2))) == RealScalar(cols));
  120. // check that linear acccessors works on blocks
  121. m1 = m1_copy;
  122. if((MatrixType::Flags&RowMajorBit)==0)
  123. VERIFY_IS_EQUAL(m1.leftCols(c1).coeff(r1+c1*rows), m1(r1,c1));
  124. else
  125. VERIFY_IS_EQUAL(m1.topRows(r1).coeff(c1+r1*cols), m1(r1,c1));
  126. // now test some block-inside-of-block.
  127. // expressions with direct access
  128. VERIFY_IS_EQUAL( (m1.block(r1,c1,rows-r1,cols-c1).block(r2-r1,c2-c1,rows-r2,cols-c2)) , (m1.block(r2,c2,rows-r2,cols-c2)) );
  129. VERIFY_IS_EQUAL( (m1.block(r1,c1,r2-r1+1,c2-c1+1).row(0)) , (m1.row(r1).segment(c1,c2-c1+1)) );
  130. VERIFY_IS_EQUAL( (m1.block(r1,c1,r2-r1+1,c2-c1+1).col(0)) , (m1.col(c1).segment(r1,r2-r1+1)) );
  131. VERIFY_IS_EQUAL( (m1.block(r1,c1,r2-r1+1,c2-c1+1).transpose().col(0)) , (m1.row(r1).segment(c1,c2-c1+1)).transpose() );
  132. VERIFY_IS_EQUAL( (m1.transpose().block(c1,r1,c2-c1+1,r2-r1+1).col(0)) , (m1.row(r1).segment(c1,c2-c1+1)).transpose() );
  133. // expressions without direct access
  134. VERIFY_IS_APPROX( ((m1+m2).block(r1,c1,rows-r1,cols-c1).block(r2-r1,c2-c1,rows-r2,cols-c2)) , ((m1+m2).block(r2,c2,rows-r2,cols-c2)) );
  135. VERIFY_IS_APPROX( ((m1+m2).block(r1,c1,r2-r1+1,c2-c1+1).row(0)) , ((m1+m2).row(r1).segment(c1,c2-c1+1)) );
  136. VERIFY_IS_APPROX( ((m1+m2).block(r1,c1,r2-r1+1,c2-c1+1).row(0)) , ((m1+m2).eval().row(r1).segment(c1,c2-c1+1)) );
  137. VERIFY_IS_APPROX( ((m1+m2).block(r1,c1,r2-r1+1,c2-c1+1).col(0)) , ((m1+m2).col(c1).segment(r1,r2-r1+1)) );
  138. VERIFY_IS_APPROX( ((m1+m2).block(r1,c1,r2-r1+1,c2-c1+1).transpose().col(0)) , ((m1+m2).row(r1).segment(c1,c2-c1+1)).transpose() );
  139. VERIFY_IS_APPROX( ((m1+m2).transpose().block(c1,r1,c2-c1+1,r2-r1+1).col(0)) , ((m1+m2).row(r1).segment(c1,c2-c1+1)).transpose() );
  140. VERIFY_IS_APPROX( ((m1+m2).template block<Dynamic,1>(r1,c1,r2-r1+1,1)) , ((m1+m2).eval().col(c1).eval().segment(r1,r2-r1+1)) );
  141. VERIFY_IS_APPROX( ((m1+m2).template block<1,Dynamic>(r1,c1,1,c2-c1+1)) , ((m1+m2).eval().row(r1).eval().segment(c1,c2-c1+1)) );
  142. VERIFY_IS_APPROX( ((m1+m2).transpose().template block<1,Dynamic>(c1,r1,1,r2-r1+1)) , ((m1+m2).eval().col(c1).eval().segment(r1,r2-r1+1)).transpose() );
  143. VERIFY_IS_APPROX( (m1+m2).row(r1).eval(), (m1+m2).eval().row(r1) );
  144. VERIFY_IS_APPROX( (m1+m2).adjoint().col(r1).eval(), (m1+m2).adjoint().eval().col(r1) );
  145. VERIFY_IS_APPROX( (m1+m2).adjoint().row(c1).eval(), (m1+m2).adjoint().eval().row(c1) );
  146. VERIFY_IS_APPROX( (m1*1).row(r1).segment(c1,c2-c1+1).eval(), m1.row(r1).eval().segment(c1,c2-c1+1).eval() );
  147. VERIFY_IS_APPROX( m1.col(c1).reverse().segment(r1,r2-r1+1).eval(),m1.col(c1).reverse().eval().segment(r1,r2-r1+1).eval() );
  148. VERIFY_IS_APPROX( (m1*1).topRows(r1), m1.topRows(r1) );
  149. VERIFY_IS_APPROX( (m1*1).leftCols(c1), m1.leftCols(c1) );
  150. VERIFY_IS_APPROX( (m1*1).transpose().topRows(c1), m1.transpose().topRows(c1) );
  151. VERIFY_IS_APPROX( (m1*1).transpose().leftCols(r1), m1.transpose().leftCols(r1) );
  152. VERIFY_IS_APPROX( (m1*1).transpose().middleRows(c1,c2-c1+1), m1.transpose().middleRows(c1,c2-c1+1) );
  153. VERIFY_IS_APPROX( (m1*1).transpose().middleCols(r1,r2-r1+1), m1.transpose().middleCols(r1,r2-r1+1) );
  154. // evaluation into plain matrices from expressions with direct access (stress MapBase)
  155. DynamicMatrixType dm;
  156. DynamicVectorType dv;
  157. dm.setZero();
  158. dm = m1.block(r1,c1,rows-r1,cols-c1).block(r2-r1,c2-c1,rows-r2,cols-c2);
  159. VERIFY_IS_EQUAL(dm, (m1.block(r2,c2,rows-r2,cols-c2)));
  160. dm.setZero();
  161. dv.setZero();
  162. dm = m1.block(r1,c1,r2-r1+1,c2-c1+1).row(0).transpose();
  163. dv = m1.row(r1).segment(c1,c2-c1+1);
  164. VERIFY_IS_EQUAL(dv, dm);
  165. dm.setZero();
  166. dv.setZero();
  167. dm = m1.col(c1).segment(r1,r2-r1+1);
  168. dv = m1.block(r1,c1,r2-r1+1,c2-c1+1).col(0);
  169. VERIFY_IS_EQUAL(dv, dm);
  170. dm.setZero();
  171. dv.setZero();
  172. dm = m1.block(r1,c1,r2-r1+1,c2-c1+1).transpose().col(0);
  173. dv = m1.row(r1).segment(c1,c2-c1+1);
  174. VERIFY_IS_EQUAL(dv, dm);
  175. dm.setZero();
  176. dv.setZero();
  177. dm = m1.row(r1).segment(c1,c2-c1+1).transpose();
  178. dv = m1.transpose().block(c1,r1,c2-c1+1,r2-r1+1).col(0);
  179. VERIFY_IS_EQUAL(dv, dm);
  180. VERIFY_IS_EQUAL( (m1.template block<Dynamic,1>(1,0,0,1)), m1.block(1,0,0,1));
  181. VERIFY_IS_EQUAL( (m1.template block<1,Dynamic>(0,1,1,0)), m1.block(0,1,1,0));
  182. VERIFY_IS_EQUAL( ((m1*1).template block<Dynamic,1>(1,0,0,1)), m1.block(1,0,0,1));
  183. VERIFY_IS_EQUAL( ((m1*1).template block<1,Dynamic>(0,1,1,0)), m1.block(0,1,1,0));
  184. if (rows>=2 && cols>=2)
  185. {
  186. VERIFY_RAISES_ASSERT( m1 += m1.col(0) );
  187. VERIFY_RAISES_ASSERT( m1 -= m1.col(0) );
  188. VERIFY_RAISES_ASSERT( m1.array() *= m1.col(0).array() );
  189. VERIFY_RAISES_ASSERT( m1.array() /= m1.col(0).array() );
  190. }
  191. VERIFY_IS_EQUAL( m1.template subVector<Horizontal>(r1), m1.row(r1) );
  192. VERIFY_IS_APPROX( (m1+m1).template subVector<Horizontal>(r1), (m1+m1).row(r1) );
  193. VERIFY_IS_EQUAL( m1.template subVector<Vertical>(c1), m1.col(c1) );
  194. VERIFY_IS_APPROX( (m1+m1).template subVector<Vertical>(c1), (m1+m1).col(c1) );
  195. VERIFY_IS_EQUAL( m1.template subVectors<Horizontal>(), m1.rows() );
  196. VERIFY_IS_EQUAL( m1.template subVectors<Vertical>(), m1.cols() );
  197. if (rows>=2 || cols>=2) {
  198. VERIFY_IS_EQUAL( int(m1.middleCols(0,0).IsRowMajor), int(m1.IsRowMajor) );
  199. VERIFY_IS_EQUAL( m1.middleCols(0,0).outerSize(), m1.IsRowMajor ? rows : 0);
  200. VERIFY_IS_EQUAL( m1.middleCols(0,0).innerSize(), m1.IsRowMajor ? 0 : rows);
  201. VERIFY_IS_EQUAL( int(m1.middleRows(0,0).IsRowMajor), int(m1.IsRowMajor) );
  202. VERIFY_IS_EQUAL( m1.middleRows(0,0).outerSize(), m1.IsRowMajor ? 0 : cols);
  203. VERIFY_IS_EQUAL( m1.middleRows(0,0).innerSize(), m1.IsRowMajor ? cols : 0);
  204. }
  205. }
  206. template<typename MatrixType>
  207. void compare_using_data_and_stride(const MatrixType& m)
  208. {
  209. Index rows = m.rows();
  210. Index cols = m.cols();
  211. Index size = m.size();
  212. Index innerStride = m.innerStride();
  213. Index outerStride = m.outerStride();
  214. Index rowStride = m.rowStride();
  215. Index colStride = m.colStride();
  216. const typename MatrixType::Scalar* data = m.data();
  217. for(int j=0;j<cols;++j)
  218. for(int i=0;i<rows;++i)
  219. VERIFY(m.coeff(i,j) == data[i*rowStride + j*colStride]);
  220. if(!MatrixType::IsVectorAtCompileTime)
  221. {
  222. for(int j=0;j<cols;++j)
  223. for(int i=0;i<rows;++i)
  224. VERIFY(m.coeff(i,j) == data[(MatrixType::Flags&RowMajorBit)
  225. ? i*outerStride + j*innerStride
  226. : j*outerStride + i*innerStride]);
  227. }
  228. if(MatrixType::IsVectorAtCompileTime)
  229. {
  230. VERIFY(innerStride == int((&m.coeff(1))-(&m.coeff(0))));
  231. for (int i=0;i<size;++i)
  232. VERIFY(m.coeff(i) == data[i*innerStride]);
  233. }
  234. }
  235. template<typename MatrixType>
  236. void data_and_stride(const MatrixType& m)
  237. {
  238. Index rows = m.rows();
  239. Index cols = m.cols();
  240. Index r1 = internal::random<Index>(0,rows-1);
  241. Index r2 = internal::random<Index>(r1,rows-1);
  242. Index c1 = internal::random<Index>(0,cols-1);
  243. Index c2 = internal::random<Index>(c1,cols-1);
  244. MatrixType m1 = MatrixType::Random(rows, cols);
  245. compare_using_data_and_stride(m1.block(r1, c1, r2-r1+1, c2-c1+1));
  246. compare_using_data_and_stride(m1.transpose().block(c1, r1, c2-c1+1, r2-r1+1));
  247. compare_using_data_and_stride(m1.row(r1));
  248. compare_using_data_and_stride(m1.col(c1));
  249. compare_using_data_and_stride(m1.row(r1).transpose());
  250. compare_using_data_and_stride(m1.col(c1).transpose());
  251. }
  252. EIGEN_DECLARE_TEST(block)
  253. {
  254. for(int i = 0; i < g_repeat; i++) {
  255. CALL_SUBTEST_1( block(Matrix<float, 1, 1>()) );
  256. CALL_SUBTEST_1( block(Matrix<float, 1, Dynamic>(internal::random(2,50))) );
  257. CALL_SUBTEST_1( block(Matrix<float, Dynamic, 1>(internal::random(2,50))) );
  258. CALL_SUBTEST_2( block(Matrix4d()) );
  259. CALL_SUBTEST_3( block(MatrixXcf(internal::random(2,50), internal::random(2,50))) );
  260. CALL_SUBTEST_4( block(MatrixXi(internal::random(2,50), internal::random(2,50))) );
  261. CALL_SUBTEST_5( block(MatrixXcd(internal::random(2,50), internal::random(2,50))) );
  262. CALL_SUBTEST_6( block(MatrixXf(internal::random(2,50), internal::random(2,50))) );
  263. CALL_SUBTEST_7( block(Matrix<int,Dynamic,Dynamic,RowMajor>(internal::random(2,50), internal::random(2,50))) );
  264. CALL_SUBTEST_8( block(Matrix<float,Dynamic,4>(3, 4)) );
  265. #ifndef EIGEN_DEFAULT_TO_ROW_MAJOR
  266. CALL_SUBTEST_6( data_and_stride(MatrixXf(internal::random(5,50), internal::random(5,50))) );
  267. CALL_SUBTEST_7( data_and_stride(Matrix<int,Dynamic,Dynamic,RowMajor>(internal::random(5,50), internal::random(5,50))) );
  268. #endif
  269. }
  270. }