[Boost-bugs] [Boost C++ Libraries] #6327: Error in documentation of boost::numeric::ublas::triangular_matrix

Subject: [Boost-bugs] [Boost C++ Libraries] #6327: Error in documentation of boost::numeric::ublas::triangular_matrix
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-12-28 11:26:12

#6327: Error in documentation of boost::numeric::ublas::triangular_matrix
---------------------------------------------------------------+------------
 Reporter:  Roman Werpachowski <roman.werpachowski@…>          |       Owner:  guwi17  
     Type:  Bugs                                               |      Status:  new     
Milestone:  To Be Determined                                   |   Component:  uBLAS   
  Version:  Boost 1.48.0                                       |    Severity:  Cosmetic
 Keywords:                                                     |  
---------------------------------------------------------------+------------
 The documentation under
 http://www.boost.org/doc/libs/1_48_0/libs/numeric/ublas/doc/triangular.htm#1TriangularMatrix

 says in Section 1.1:

 ''For a (n x n )-dimensional '''lower''' triangular matrix and 0 <= i <
 n,0 <= j < n holds ti, j = 0 , if i > j. If furthermore holds ti, i= 1 the
 matrix is called unit '''lower''' triangular. For a (n x n )-dimensional
 lower triangular matrix and 0 <= i < n,0 <= j < n holds ti, j = 0 , if i <
 j. If furthermore holds ti, i= 1 the matrix is called unit lower
 triangular.''

 Based on the code example in Section 1.2, I think that the bolded
 occurrences of "lower" should be replaced with "upper", so that the above
 paragraph reads:

 ''For a (n x n )-dimensional '''upper''' triangular matrix and 0 <= i <
 n,0 <= j < n holds ti, j = 0 , if i > j. If furthermore holds ti, i= 1 the
 matrix is called unit '''upper''' triangular. For a (n x n )-dimensional
 lower triangular matrix and 0 <= i < n,0 <= j < n holds ti, j = 0 , if i <
 j. If furthermore holds ti, i= 1 the matrix is called unit lower
 triangular.''

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/6327>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.