1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
      91
      92
      93
      94
      95
      96
      97
      98
      99
     100
     101
     102
     103
     104
     105
     106
     107
     108
     109
     110
     111
     112
     113
     114
     115
     116
     117
     118
     119
     120
     121
     122
     123
     124
     125
     126
     127
     128
     129
     130
     131
     132
     133
     134
     135
     136
     137
     138
     139
     140
     141
     142
     143
     144
     145
     146
     147
     148
     149
     150
     151
     152
     153
     154
     155
     156
     157
     158
     159
     160
     161
     162
     163
     164
     165
     166
     167
     168
     169
     170
     171
     172
     173
     174
     175
     176
     177
     178
     179
     180
     181
     182
     183
     184
     185
     186
     187
     188
     189
     190
     191
     192
     193
     194
     195
     196
     197
     198
     199
     200
     201
     202
     203
     204
     205
     206
     207
     208
     209
     210
     211
     212
     213
     214
     215
     216
     217
     218
     219
     220
     221
     222
     223
     224
     225
     226
     227
     228
     229
     230
     231
     232
     233
     234
     235
     236
     237
     238
     239
     240
     241
     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
     252
     253
     254
     255
     256
     257
     258
     259
     260
     261
     262
     263
     264
     265
     266
     267
     268
     269
     270
     271
     272
     273
     274
     275
     276
     277
     278
     279
     280
     281
     282
     283
     284
     285
     286
     287
     288
     289
     290
     291
     292
     293
     294
     295
     296
     297
     298
     299
     300
     301
     302
     303
     304
     305
     306
     307
     308
     309
     310
     311
     312
     313
     314
     315
     316
     317
     318
     319
     320
     321
     322
     323
     324
     325
     326
     327
     328
     329
     330
     331
     332
     333
     334
     335
     336
     337
     338
     339
     340
     341
     342
     343
     344
     345
     346
     347
     348
     349
     350
     351
     352
     353
     354
     355
     356
     357
     358
     359
     360
     361
     362
     363
     364
     365
     366
     367
     368
     369
     370
     371
     372
     373
     374
     375
     376
     377
     378
     379
     380
     381
     382
     383
     384
     385
     386
     387
     388
     389
     390
     391
     392
     393
     394
     395
     396
     397
     398
     399
     400
     401
     402
     403
     404
     405
     406
     407
     408
     409
     410
     411
     412
     413
     414
     415
     416
     417
     418
     419
     420
     421
     422
     423
     424
     425
     426
     427
     428
     429
     430
     431
     432
     433
     434
     435
     436
     437
     438
     439
     440
     441
     442
     443
     444
     445
     446
     447
     448
     449
     450
     451
     452
     453
     454
     455
     456
     457
     458
     459
     460
     461
/*
 *   Copyright (c) 2012, Michael Lehn
 *
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *   1) Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *   2) Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the
 *      distribution.
 *   3) Neither the name of the FLENS development group nor the names of
 *      its contributors may be used to endorse or promote products derived
 *      from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* Based on
 *
       SUBROUTINE DLAIC1( JOB, J, X, SEST, W, GAMMA, SESTPR, S, C )
 *
 *  -- LAPACK auxiliary routine (version 3.3.1) --
 *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
 *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
 *  -- April 2011                                                      --
 *
 */

#ifndef FLENS_LAPACK_LA_LAIC1_TCC
#define FLENS_LAPACK_LA_LAIC1_TCC 1

#include <flens/lapack/lapack.h>
#include <flens/matrixtypes/matrixtypes.h>
#include <flens/vectortypes/vectortypes.h>

namespace flens { namespace lapack {

//== generic lapack implementation =============================================

namespace generic {

//-- laic1 [real variant] ------------------------------------------------------

template <typename VX, typename SEST, typename VW, typename GAMMA,
          typename SESTPR, typename S, typename C>
void
laic1_impl(LAIC1::Job               job,
           const DenseVector<VX>    &x,
           SEST                     sEst,
           const DenseVector<VW>    &w,
           const GAMMA              &gamma,
           SESTPR                   &sEstPr,
           S                        &s,
           C                        &c)
{
    using std::abs;
    using std::max;
    using std::sqrt;
    using cxxblas::conjugate;

    typedef typename DenseVector<VX>::ElementType              ElementType;
    typedef typename DenseVector<VX>::IndexType                IndexType;
    typedef typename ComplexTrait<ElementType>::PrimitiveType  PrimitiveType;

    const PrimitiveType Zero(0), One(1), Two(2), Half(0.5), Four(4);

    const PrimitiveType eps   = lamch<PrimitiveType>(Eps);
    const ElementType   alpha = x*w;

    const PrimitiveType absAlpha = abs(alpha);
    const PrimitiveType absGamma = abs(gamma);
    const PrimitiveType absEst   = abs(sEst);

    PrimitiveType s1, s2, tmp, zeta1, zeta2, b, t, scl, normA;
    ElementType   cosine, sine;

    if (job==LAIC1::Max) {
//
//      Estimating largest singular value
//
//      special cases
//
        if (sEst==Zero) {
            s1 =max(absGamma, absAlpha);
            if (s1==Zero) {
                s = Zero;
                c = One;
                sEstPr = Zero;
            } else {
                s = alpha / s1;
                c = gamma / s1;
                tmp = sqrt(s*conjugate(s) + c*conjugate(c));
                s /= tmp;
                c /= tmp;
                sEstPr = s1*tmp;
            }
            return;
        } else if (absGamma<=eps*absEst) {
            s = One;
            c = Zero;
            tmp = max(absEst, absAlpha);
            s1 = absEst / tmp;
            s2 = absAlpha / tmp;
            sEstPr = tmp*sqrt(s1*s1 + s2*s2);
            return;
        } else if (absAlpha<=eps*absEst) {
            s1 = absGamma;
            s2 = absEst;
            if (s1<=s2) {
                s = One;
                c = Zero;
                sEstPr = s2;
            } else {
                s = Zero;
                c = One;
                sEstPr = s1;
            }
            return;
        } else if (absEst<=eps*absAlpha || absEst<=eps*absGamma) {
            s1 = absGamma;
            s2 = absAlpha;
            if (s1<=s2) {
                tmp = s1 / s2;
                if (IsComplex<ElementType>::value) {
                    scl = sqrt(One + tmp*tmp);
                    sEstPr = s2*scl;
                    s = (alpha/s2) / scl;
                    c = (gamma/s2) / scl;
                } else {
                    s = sqrt(One + tmp*tmp);
                    sEstPr = s2*s;
                    c = (gamma/s2) / s;
                    s = sign(One, alpha) / s;
                }
            } else {
                tmp = s2 / s1;
                if (IsComplex<ElementType>::value) {
                    scl = sqrt(One + tmp*tmp);
                    sEstPr = s1*scl;
                    s = (alpha/s1) / scl;
                    c = (gamma/s1) / scl;
                } else {
                    c = sqrt(One + tmp*tmp);
                    sEstPr = s1*c;
                    s = (alpha/s1) / c;
                    c = sign(One, gamma) / c;
                }
            }
            return;
        } else {
//
//          normal case
//
            if (IsComplex<ElementType>::value) {
                zeta1 = absAlpha / absEst;
                zeta2 = absGamma / absEst;
            } else {
                zeta1 = alpha / absEst;
                zeta2 = gamma / absEst;
            }

            b = (One - zeta1*zeta1 - zeta2*zeta2)*Half;
            c = zeta1*zeta1;
            if (b>Zero) {
                t = c / (b+sqrt(b*b+c));
            } else {
                t = sqrt(b*b+c) - b;
            }

            if (IsComplex<ElementType>::value) {
                sine   = -(alpha / absEst) / t;
                cosine = -(gamma / absEst) / (One +t);
            } else {
                sine   = -zeta1 / t;
                cosine = -zeta2 / (One +t);
            }
            tmp = sqrt(sine*conjugate(sine) + cosine*conjugate(cosine));
            s = sine / tmp;
            c = cosine / tmp;
            sEstPr = sqrt(t + One)*absEst;
            return;
        }

    } else if (job==LAIC1::Min) {
//
//      Estimating smallest singular value
//
//      special cases
//
        if (sEst==Zero) {
            sEstPr = Zero;
            if (max(absGamma, absAlpha)==Zero) {
                sine   = One;
                cosine = Zero;
            } else {
                sine   = -gamma;
                cosine = alpha;
            }
            s1 = max(abs(sine), abs(cosine));
            s = sine / s1;
            c = cosine / s1;
            tmp = sqrt(s*conjugate(s) + c*conjugate(c));
            s /= tmp;
            c /= tmp;
            return;
        } else if (absGamma<=eps*absEst) {
            s = Zero;
            c = One;
            sEstPr = absGamma;
            return;
        } else if (absAlpha<=eps*absEst) {
            s1 = absGamma;
            s2 = absEst;
            if (s1<=s2) {
                s = Zero;
                c = One;
                sEstPr = s1;
            } else {
                s = One;
                c = Zero;
                sEstPr = s2;
            }
            return;
        } else if (absEst<=eps*absAlpha || absEst<=eps*absGamma) {
            s1 = absGamma;
            s2 = absAlpha;
            if (s1<=s2) {
                tmp = s1 / s2;
                if (IsComplex<ElementType>::value) {
                    scl = sqrt(One + tmp*tmp);
                    sEstPr = absEst*(tmp/scl);
                    s = -(conjugate(gamma) / s2) / scl;
                    c =  (conjugate(alpha) / s2) / scl;
                } else {
                    c = sqrt(One + tmp*tmp);
                    sEstPr = absEst*(tmp/c);
                    s = -(gamma / s2) / c;
                    c = sign(One, alpha) / c;
                }
            } else {
                tmp = s2 / s1;
                if (IsComplex<ElementType>::value) {
                    scl = sqrt(One + tmp*tmp);
                    sEstPr = absEst / scl;
                    s = -(conjugate(gamma) / s1) / scl;
                    c =  (conjugate(alpha) / s1) / scl;
                } else {
                    s = sqrt(One + tmp*tmp);
                    sEstPr = absEst / s;
                    c = (alpha / s1) / s;
                    s = -sign(One, gamma) / s;
                }
            }
            return;
        } else {
//
//          normal case
//
            if (IsComplex<ElementType>::value) {
                zeta1 = absAlpha / absEst;
                zeta2 = absGamma / absEst;
            } else {
                zeta1 = alpha / absEst;
                zeta2 = gamma / absEst;
            }

            normA = max(One + zeta1*zeta1 + abs(zeta1*zeta2),
                        abs(zeta1*zeta2) + zeta2*zeta2);
//
//          See if root is closer to zero or to ONE
//
            PrimitiveType test = One + Two*(zeta1-zeta2)*(zeta1+zeta2);
            if (test>=Zero) {
//
//              root is close to zero, compute directly
//
                b = (zeta1*zeta1 + zeta2*zeta2 + One)*Half;
                c = zeta2*zeta2;
                t = c / (b + sqrt(abs(b*b-c)));
                if (IsComplex<ElementType>::value) {
                    sine   = (alpha/absEst) / (One - t);
                    cosine = -(gamma/absEst) / t;
                } else {
                    sine   = zeta1 / (One - t);
                    cosine = -zeta2 / t;
                }
                sEstPr = sqrt(t + Four*eps*eps*normA) * absEst;
            } else {
//
//              root is closer to ONE, shift by that amount
//
                b = (zeta2*zeta2 + zeta1*zeta1 - One)*Half;
                c = zeta1*zeta1;
                if (b>=Zero) {
                    t = -c / (b + sqrt(b*b + c));
                } else {
                    t = b - sqrt(b*b + c);
                }
                if (IsComplex<ElementType>::value) {
                    sine   = -(alpha/absEst) / t;
                    cosine = -(gamma/absEst) / (One + t);
                } else {
                    sine   = -zeta1 / t;
                    cosine = -zeta2 / (One + t);
                }
                sEstPr = sqrt(One + t + Four*eps*eps*normA)*absEst;
            }
            tmp = sqrt(sine*conjugate(sine) + cosine*conjugate(cosine));
            s = sine / tmp;
            c = cosine / tmp;
            return;

        }
    }

}

// namespace generic


//== interface for native lapack ===============================================

#ifdef USE_CXXLAPACK

namespace external {

//-- laic1 [real variant] ------------------------------------------------------

template <typename VX, typename SEST, typename VW, typename GAMMA,
          typename SESTPR, typename S, typename C>
void
laic1_impl(LAIC1::Job               job,
           const DenseVector<VX>    &x,
           SEST                     sEst,
           const DenseVector<VW>    &w,
           const GAMMA              &gamma,
           SESTPR                   &sEstPr,
           S                        &s,
           C                        &c)
{
    typedef typename DenseVector<VX>::IndexType  IndexType;

    cxxlapack::laic1<IndexType>(IndexType(job),
                                x.length(),
                                x.data(),
                                sEst,
                                w.data(),
                                gamma,
                                sEstPr,
                                s,
                                c);
}

// namespace external

#endif // USE_CXXLAPACK


//== public interface ==========================================================

//-- laic1 [real variant] ------------------------------------------------------

template <typename VX, typename SEST, typename VW, typename GAMMA,
          typename SESTPR, typename S, typename C>
void
laic1(LAIC1::Job                job,
      const DenseVector<VX>     &x,
      SEST                      sEst,
      const DenseVector<VW>     &w,
      const GAMMA               &gamma,
      SESTPR                    &sEstPr,
      S                         &s,
      C                         &c)
{

//
//  Test the input parameters
//
#   ifndef NDEBUG
    ASSERT(x.length()==w.length());
#   endif

//
//  Make copies of output arguments
//
#   ifdef CHECK_CXXLAPACK
    SESTPR   sEstPr_org = sEstPr;
    S        s_org      = s;
    C        c_org      = c;
#   endif

//
//  Call implementation
//
    LAPACK_SELECT::laic1_impl(job, x, sEst, w, gamma, sEstPr, s, c);

#   ifdef CHECK_CXXLAPACK
//
//  Make copies of results computed by the generic implementation
//
    SESTPR   sEstPr_generic = sEstPr;
    S        s_generic      = s;
    C        c_generic      = c;

//
//  restore output arguments
//
    sEstPr = sEstPr_org;
    s      = s_org;
    c      = c_org;

//
//  Compare generic results with results from the native implementation
//
    external::laic1_impl(job, x, sEst, w, gamma, sEstPr, s, c);

    bool failed = false;
    if (! isIdentical(sEstPr_generic, sEstPr, "sEstPr_generic""sEstPr")) {
        std::cerr << "CXXLAPACK: sEstPr_generic = "
                  << sEstPr_generic << std::endl;
        std::cerr << "F77LAPACK: sEstPr = " << sEstPr << std::endl;
        failed = true;
    }
    if (! isIdentical(s_generic, s, "s_generic""s")) {
        std::cerr << "CXXLAPACK: s_generic = " << s_generic << std::endl;
        std::cerr << "F77LAPACK: s = " << s << std::endl;
        failed = true;
    }
    if (! isIdentical(c_generic, c, "c_generic""c")) {
        std::cerr << "CXXLAPACK: c_generic = " << c_generic << std::endl;
        std::cerr << "F77LAPACK: c = " << c << std::endl;
        failed = true;
    }

    if (failed) {
        std::cerr << "error in: laic1.tcc" << std::endl;
        ASSERT(0);
    } else {
        // std::cerr << "passed: laic1.tcc" << std::endl;
    }
#   endif
}

} } // namespace lapack, flens

#endif // FLENS_LAPACK_LA_LAIC1_TCC