scklse.f

Go to the documentation of this file.

*> \brief \b SCKLSE
*
*  =========== DOCUMENTATION ===========
*
* Online html documentation available at 
*            http://www.netlib.org/lapack/explore-html/ 
*
*  Definition:
*  ===========
*
*       SUBROUTINE SCKLSE( NN, MVAL, PVAL, NVAL, NMATS, ISEED, THRESH,
*                          NMAX, A, AF, B, BF, X, WORK, RWORK, NIN, NOUT,
*                          INFO )
* 
*       .. Scalar Arguments ..
*       INTEGER            INFO, NIN, NMATS, NMAX, NN, NOUT
*       REAL               THRESH
*       ..
*       .. Array Arguments ..
*       INTEGER            ISEED( 4 ), MVAL( * ), NVAL( * ), PVAL( * )
*       REAL               A( * ), AF( * ), B( * ), BF( * ), RWORK( * ),
*      $                   WORK( * ), X( * )
*       ..
*  
*
*> \par Purpose:
*  =============
*>
*> \verbatim
*>
*> SCKLSE tests SGGLSE - a subroutine for solving linear equality
*> constrained least square problem (LSE).
*> \endverbatim
*
*  Arguments:
*  ==========
*
*> \param[in] NN
*> \verbatim
*>          NN is INTEGER
*>          The number of values of (M,P,N) contained in the vectors
*>          (MVAL, PVAL, NVAL).
*> \endverbatim
*>
*> \param[in] MVAL
*> \verbatim
*>          MVAL is INTEGER array, dimension (NN)
*>          The values of the matrix row(column) dimension M.
*> \endverbatim
*>
*> \param[in] PVAL
*> \verbatim
*>          PVAL is INTEGER array, dimension (NN)
*>          The values of the matrix row(column) dimension P.
*> \endverbatim
*>
*> \param[in] NVAL
*> \verbatim
*>          NVAL is INTEGER array, dimension (NN)
*>          The values of the matrix column(row) dimension N.
*> \endverbatim
*>
*> \param[in] NMATS
*> \verbatim
*>          NMATS is INTEGER
*>          The number of matrix types to be tested for each combination
*>          of matrix dimensions.  If NMATS >= NTYPES (the maximum
*>          number of matrix types), then all the different types are
*>          generated for testing.  If NMATS < NTYPES, another input line
*>          is read to get the numbers of the matrix types to be used.
*> \endverbatim
*>
*> \param[in,out] ISEED
*> \verbatim
*>          ISEED is INTEGER array, dimension (4)
*>          On entry, the seed of the random number generator.  The array
*>          elements should be between 0 and 4095, otherwise they will be
*>          reduced mod 4096, and ISEED(4) must be odd.
*>          On exit, the next seed in the random number sequence after
*>          all the test matrices have been generated.
*> \endverbatim
*>
*> \param[in] THRESH
*> \verbatim
*>          THRESH is REAL
*>          The threshold value for the test ratios.  A result is
*>          included in the output file if RESULT >= THRESH.  To have
*>          every test ratio printed, use THRESH = 0.
*> \endverbatim
*>
*> \param[in] NMAX
*> \verbatim
*>          NMAX is INTEGER
*>          The maximum value permitted for M or N, used in dimensioning
*>          the work arrays.
*> \endverbatim
*>
*> \param[out] A
*> \verbatim
*>          A is REAL array, dimension (NMAX*NMAX)
*> \endverbatim
*>
*> \param[out] AF
*> \verbatim
*>          AF is REAL array, dimension (NMAX*NMAX)
*> \endverbatim
*>
*> \param[out] B
*> \verbatim
*>          B is REAL array, dimension (NMAX*NMAX)
*> \endverbatim
*>
*> \param[out] BF
*> \verbatim
*>          BF is REAL array, dimension (NMAX*NMAX)
*> \endverbatim
*>
*> \param[out] X
*> \verbatim
*>          X is REAL array, dimension (5*NMAX)
*> \endverbatim
*>
*> \param[out] WORK
*> \verbatim
*>          WORK is REAL array, dimension (NMAX*NMAX)
*> \endverbatim
*>
*> \param[out] RWORK
*> \verbatim
*>          RWORK is REAL array, dimension (NMAX)
*> \endverbatim
*>
*> \param[in] NIN
*> \verbatim
*>          NIN is INTEGER
*>          The unit number for input.
*> \endverbatim
*>
*> \param[in] NOUT
*> \verbatim
*>          NOUT is INTEGER
*>          The unit number for output.
*> \endverbatim
*>
*> \param[out] INFO
*> \verbatim
*>          INFO is INTEGER
*>          = 0 :  successful exit
*>          > 0 :  If SLATMS returns an error code, the absolute value
*>                 of it is returned.
*> \endverbatim
*
*  Authors:
*  ========
*
*> \author Univ. of Tennessee 
*> \author Univ. of California Berkeley 
*> \author Univ. of Colorado Denver 
*> \author NAG Ltd. 
*
*> \date November 2011
*
*> \ingroup single_eig
*
*  =====================================================================
      SUBROUTINE scklse( NN, MVAL, PVAL, NVAL, NMATS, ISEED, THRESH,
     $                   nmax, a, af, b, bf, x, work, rwork, nin, nout,
     $                   info )
*
*  -- LAPACK test routine (version 3.4.0) --
*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
*     November 2011
*
*     .. Scalar Arguments ..
      INTEGER            info, nin, nmats, nmax, nn, nout
      REAL               thresh
*     ..
*     .. Array Arguments ..
      INTEGER            iseed( 4 ), mval( * ), nval( * ), pval( * )
      REAL               a( * ), af( * ), b( * ), bf( * ), rwork( * ),
     $                   work( * ), x( * )
*     ..
*
*  =====================================================================
*
*     .. Parameters ..
      INTEGER            ntests
      parameter( ntests = 7 )
      INTEGER            ntypes
      parameter( ntypes = 8 )
*     ..
*     .. Local Scalars ..
      LOGICAL            firstt
      CHARACTER          dista, distb, type
      CHARACTER*3        path
      INTEGER            i, iinfo, ik, imat, kla, klb, kua, kub, lda,
     $                   ldb, lwork, m, modea, modeb, n, nfail, nrun,
     $                   nt, p
      REAL               anorm, bnorm, cndnma, cndnmb
*     ..
*     .. Local Arrays ..
      LOGICAL            dotype( ntypes )
      REAL               result( ntests )
*     ..
*     .. External Subroutines ..
      EXTERNAL           alahdg, alareq, alasum, slarhs, slatb9, slatms,
     $                   slsets
*     ..
*     .. Intrinsic Functions ..
      INTRINSIC          abs, max
*     ..
*     .. Executable Statements ..
*
*     Initialize constants and the random number seed.
*
      path( 1: 3 ) = 'LSE'
      info = 0
      nrun = 0
      nfail = 0
      firstt = .true.
      CALL alareq( path, nmats, dotype, ntypes, nin, nout )
      lda = nmax
      ldb = nmax
      lwork = nmax*nmax
*
*     Check for valid input values.
*
      DO 10 ik = 1, nn
         m = mval( ik )
         p = pval( ik )
         n = nval( ik )
         IF( p.GT.n .OR. n.GT.m+p ) THEN
            IF( firstt ) THEN
               WRITE( nout, fmt = * )
               firstt = .false.
            END IF
            WRITE( nout, fmt = 9997 )m, p, n
         END IF
   10 continue
      firstt = .true.
*
*     Do for each value of M in MVAL.
*
      DO 40 ik = 1, nn
         m = mval( ik )
         p = pval( ik )
         n = nval( ik )
         IF( p.GT.n .OR. n.GT.m+p )
     $      go to 40
*
         DO 30 imat = 1, ntypes
*
*           Do the tests only if DOTYPE( IMAT ) is true.
*
            IF( .NOT.dotype( imat ) )
     $         go to 30
*
*           Set up parameters with SLATB9 and generate test
*           matrices A and B with SLATMS.
*
            CALL slatb9( path, imat, m, p, n, type, kla, kua, klb, kub,
     $                   anorm, bnorm, modea, modeb, cndnma, cndnmb,
     $                   dista, distb )
*
            CALL slatms( m, n, dista, iseed, type, rwork, modea, cndnma,
     $                   anorm, kla, kua, 'No packing', a, lda, work,
     $                   iinfo )
            IF( iinfo.NE.0 ) THEN
               WRITE( nout, fmt = 9999 )iinfo
               info = abs( iinfo )
               go to 30
            END IF
*
            CALL slatms( p, n, distb, iseed, type, rwork, modeb, cndnmb,
     $                   bnorm, klb, kub, 'No packing', b, ldb, work,
     $                   iinfo )
            IF( iinfo.NE.0 ) THEN
               WRITE( nout, fmt = 9999 )iinfo
               info = abs( iinfo )
               go to 30
            END IF
*
*           Generate the right-hand sides C and D for the LSE.
*
            CALL slarhs( 'SGE', 'New solution', 'Upper', 'N', m, n,
     $                   max( m-1, 0 ), max( n-1, 0 ), 1, a, lda,
     $                   x( 4*nmax+1 ), max( n, 1 ), x, max( m, 1 ),
     $                   iseed, iinfo )
*
            CALL slarhs( 'SGE', 'Computed', 'Upper', 'N', p, n,
     $                   max( p-1, 0 ), max( n-1, 0 ), 1, b, ldb,
     $                   x( 4*nmax+1 ), max( n, 1 ), x( 2*nmax+1 ),
     $                   max( p, 1 ), iseed, iinfo )
*
            nt = 2
*
            CALL slsets( m, p, n, a, af, lda, b, bf, ldb, x,
     $                   x( nmax+1 ), x( 2*nmax+1 ), x( 3*nmax+1 ),
     $                   x( 4*nmax+1 ), work, lwork, rwork,
     $                   result( 1 ) )
*
*           Print information about the tests that did not
*           pass the threshold.
*
            DO 20 i = 1, nt
               IF( result( i ).GE.thresh ) THEN
                  IF( nfail.EQ.0 .AND. firstt ) THEN
                     firstt = .false.
                     CALL alahdg( nout, path )
                  END IF
                  WRITE( nout, fmt = 9998 )m, p, n, imat, i,
     $               result( i )
                  nfail = nfail + 1
               END IF
   20       continue
            nrun = nrun + nt
*
   30    continue
   40 continue
*
*     Print a summary of the results.
*
      CALL alasum( path, nout, nfail, nrun, 0 )
*
 9999 format( ' SLATMS in SCKLSE   INFO = ', i5 )
 9998 format( ' M=', i4, ' P=', i4, ', N=', i4, ', type ', i2,
     $      ', test ', i2, ', ratio=', g13.6 )
 9997 format( ' *** Invalid input  for LSE:  M = ', i6, ', P = ', i6,
     $      ', N = ', i6, ';', / '     must satisfy P <= N <= P+M  ',
     $      '(this set of values will be skipped)' )
      return
*
*     End of SCKLSE
*
      END