dynare/dynare++/sylv/testing/tests.cc

/*
 * Copyright © 2004-2011 Ondra Kamenik
 * Copyright © 2019-2022 Dynare Team
 *
 * This file is part of Dynare.
 *
 * Dynare is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Dynare is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Dynare.  If not, see <https://www.gnu.org/licenses/>.
 */

#include "SylvException.hh"
#include "QuasiTriangular.hh"
#include "QuasiTriangularZero.hh"
#include "Vector.hh"
#include "KronVector.hh"
#include "KronUtils.hh"
#include "TriangularSylvester.hh"
#include "GeneralSylvester.hh"
#include "SchurDecompEig.hh"
#include "SimilarityDecomp.hh"
#include "IterativeSylvester.hh"
#include "SylvMatrix.hh"
#include "int_power.hh"

#include "MMMatrix.hh"

#include <ctime>
#include <cmath>
#include <string>
#include <utility>
#include <iostream>
#include <iomanip>
#include <memory>

class TestRunnable
{
public:
  const std::string name;
  static constexpr double eps_norm = 1.0e-10;
  TestRunnable(std::string n) : name(std::move(n))
  {
  }
  virtual ~TestRunnable() = default;
  bool test() const;
  virtual bool run() const = 0;
protected:
  // declaration of auxiliary static methods
  static bool quasi_solve(bool trans, const std::string &mname, const std::string &vname);
  static bool mult_kron(bool trans, const std::string &mname, const std::string &vname,
                        const std::string &cname, int m, int n, int depth);
  static bool level_kron(bool trans, const std::string &mname, const std::string &vname,
                         const std::string &cname, int level, int m, int n, int depth);
  static bool kron_power(const std::string &m1name, const std::string &m2name, const std::string &vname,
                         const std::string &cname, int m, int n, int depth);
  static bool lin_eval(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       const std::string &cname, int m, int n, int depth,
                       double alpha, double beta1, double beta2);
  static bool qua_eval(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       const std::string &cname, int m, int n, int depth,
                       double alpha, double betas, double gamma,
                       double delta1, double delta2);
  static bool tri_sylv(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       int m, int n, int depth);
  static bool gen_sylv(const std::string &aname, const std::string &bname, const std::string &cname,
                       const std::string &dname, int m, int n, int order);
  static bool eig_bubble(const std::string &aname, int from, int to);
  static bool block_diag(const std::string &aname, double log10norm = 3.0);
  static bool iter_sylv(const std::string &m1name, const std::string &m2name, const std::string &vname,
                        int m, int n, int depth);
};

bool
TestRunnable::test() const
{
  std::cout << "Running test <" << name << '>' << std::endl;
  clock_t start = clock();
  bool passed = run();
  clock_t end = clock();
  std::cout << "CPU time " << (static_cast<double>(end-start))/CLOCKS_PER_SEC << " (CPU seconds)..................";
  if (passed)
    std::cout << "passed";
  else
    std::cout << "FAILED";
  std::cout << std::endl << std::endl;
  return passed;
}

/**********************************************************/
/*   auxiliary methods                                    */
/**********************************************************/

bool
TestRunnable::quasi_solve(bool trans, const std::string &mname, const std::string &vname)
{
  MMMatrixIn mmt(mname);
  MMMatrixIn mmv(vname);

  std::unique_ptr<QuasiTriangular> t;
  std::unique_ptr<QuasiTriangular> tsave;
  if (mmt.row() == mmt.col())
    {
      t = std::make_unique<QuasiTriangular>(mmt.getData(), mmt.row());
      tsave = std::make_unique<QuasiTriangular>(*t);
    }
  else if (mmt.row() > mmt.col())
    {
      t = std::make_unique<QuasiTriangularZero>(mmt.row()-mmt.col(), mmt.getData(), mmt.col());
      tsave = std::make_unique<QuasiTriangularZero>(const_cast<const QuasiTriangularZero &>(dynamic_cast<QuasiTriangularZero &>(*t)));
    }
  else
    {
      std::cout << "  Wrong quasi triangular dimensions, rows must be >= cols.\n";
      return false;
    }
  ConstVector v{mmv.getData()};
  Vector x(v.length());
  double eig_min = 1.0e20;
  if (trans)
    t->solveTrans(x, v, eig_min);
  else
    t->solve(x, v, eig_min);
  std::cout << "eig_min = " << eig_min << std::endl;
  Vector xx(v.length());
  if (trans)
    tsave->multVecTrans(xx, ConstVector(x));
  else
    tsave->multVec(xx, ConstVector(x));
  xx.add(-1.0, v);
  xx.add(1.0, x);
  double norm = xx.getNorm();
  std::cout << "\terror norm = " << norm << std::endl;
  return (norm < eps_norm);
}

bool
TestRunnable::mult_kron(bool trans, const std::string &mname, const std::string &vname,
                        const std::string &cname, int m, int n, int depth)
{
  MMMatrixIn mmt(mname);
  MMMatrixIn mmv(vname);
  MMMatrixIn mmc(cname);

  int length = power(m, depth)*n;
  if (mmt.row() != m
      || mmv.row() != length
      || mmc.row() != length)
    {
      std::cout << "  Incompatible sizes for kron mult action, len=" << length
                << ", matrow=" << mmt.row() << ", m=" << m
                << ", vrow=" << mmv.row() << ", crow=" << mmc.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t(mmt.getData(), mmt.row());
  Vector vraw{mmv.getData()};
  KronVector v(vraw, m, n, depth);
  Vector craw{mmc.getData()};
  KronVector c(craw, m, n, depth);
  if (trans)
    t.multKronTrans(v);
  else
    t.multKron(v);
  c.add(-1.0, v);
  double norm = c.getNorm();
  std::cout << "\terror norm = " << norm << std::endl;
  return (norm < eps_norm);
}

bool
TestRunnable::level_kron(bool trans, const std::string &mname, const std::string &vname,
                         const std::string &cname, int level, int m, int n, int depth)
{
  MMMatrixIn mmt(mname);
  MMMatrixIn mmv(vname);
  MMMatrixIn mmc(cname);

  int length = power(m, depth)*n;
  if ((level > 0 && mmt.row() != m)
      || (level == 0 && mmt.row() != n)
      || mmv.row() != length
      || mmc.row() != length)
    {
      std::cout << "  Incompatible sizes for kron mult action, len=" << length
                << ", matrow=" << mmt.row() << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row() << ", crow=" << mmc.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t(mmt.getData(), mmt.row());
  Vector vraw{mmv.getData()};
  ConstKronVector v(vraw, m, n, depth);
  Vector craw{mmc.getData()};
  KronVector c(craw, m, n, depth);
  KronVector x(v);
  if (trans)
    KronUtils::multAtLevelTrans(level, t, x);
  else
    KronUtils::multAtLevel(level, t, x);
  x.add(-1, c);
  double norm = x.getNorm();
  std::cout << "\terror norm = " << norm << std::endl;
  return (norm < eps_norm);
}

bool
TestRunnable::kron_power(const std::string &m1name, const std::string &m2name, const std::string &vname,
                         const std::string &cname, int m, int n, int depth)
{
  MMMatrixIn mmt1(m1name);
  MMMatrixIn mmt2(m2name);
  MMMatrixIn mmv(vname);
  MMMatrixIn mmc(cname);

  int length = power(m, depth)*n;
  if (mmt1.row() != m
      || mmt2.row() != n
      || mmv.row() != length
      || mmc.row() != length)
    {
      std::cout << "  Incompatible sizes for kron power mult action, len=" << length
                << ", row1=" << mmt1.row() << ", row2=" << mmt2.row()
                << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row() << ", crow=" << mmc.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t1(mmt1.getData(), mmt1.row());
  QuasiTriangular t2(mmt2.getData(), mmt2.row());
  Vector vraw{mmv.getData()};
  ConstKronVector v(vraw, m, n, depth);
  Vector craw{mmc.getData()};
  KronVector c(craw, m, n, depth);
  KronVector x(v);
  KronUtils::multKron(t1, t2, x);
  x.add(-1, c);
  double norm = x.getNorm();
  std::cout << "\terror norm = " << norm << std::endl;
  return (norm < eps_norm);
}

bool
TestRunnable::lin_eval(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       const std::string &cname, int m, int n, int depth,
                       double alpha, double beta1, double beta2)
{
  MMMatrixIn mmt1(m1name);
  MMMatrixIn mmt2(m2name);
  MMMatrixIn mmv(vname);
  MMMatrixIn mmc(cname);

  int length = power(m, depth)*n;
  if (mmt1.row() != m
      || mmt2.row() != n
      || mmv.row() != 2*length
      || mmc.row() != 2*length)
    {
      std::cout << "  Incompatible sizes for lin eval action, len=" << length
                << ", row1=" << mmt1.row() << ", row2=" << mmt2.row()
                << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row() << ", crow=" << mmc.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t1(mmt1.getData(), mmt1.row());
  QuasiTriangular t2(mmt2.getData(), mmt2.row());
  TriangularSylvester ts(t2, t1);
  ConstVector vraw1{mmv.getData(), 0, length};
  ConstKronVector v1(vraw1, m, n, depth);
  ConstVector vraw2{mmv.getData(), length, length};
  ConstKronVector v2(vraw2, m, n, depth);
  ConstVector craw1{mmc.getData(), 0, length};
  ConstKronVector c1(craw1, m, n, depth);
  ConstVector craw2{mmc.getData(), length, length};
  ConstKronVector c2(craw2, m, n, depth);
  KronVector x1(m, n, depth);
  KronVector x2(m, n, depth);
  ts.linEval(alpha, beta1, beta2, x1, x2, v1, v2);
  x1.add(-1, c1);
  x2.add(-1, c2);
  double norm1 = x1.getNorm();
  double norm2 = x2.getNorm();
  std::cout << "\terror norm1 = " << norm1 << "\n\terror norm2 = " << norm2 << '\n';
  return (norm1*norm1+norm2*norm2 < eps_norm*eps_norm);
}

bool
TestRunnable::qua_eval(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       const std::string &cname, int m, int n, int depth,
                       double alpha, double betas, double gamma,
                       double delta1, double delta2)
{
  MMMatrixIn mmt1(m1name);
  MMMatrixIn mmt2(m2name);
  MMMatrixIn mmv(vname);
  MMMatrixIn mmc(cname);

  int length = power(m, depth)*n;
  if (mmt1.row() != m
      || mmt2.row() != n
      || mmv.row() != 2*length
      || mmc.row() != 2*length)
    {
      std::cout << "  Incompatible sizes for qua eval action, len=" << length
                << ", row1=" << mmt1.row() << ", row2=" << mmt2.row()
                << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row() << ", crow=" << mmc.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t1(mmt1.getData(), mmt1.row());
  QuasiTriangular t2(mmt2.getData(), mmt2.row());
  TriangularSylvester ts(t2, t1);
  ConstVector vraw1{mmv.getData(), 0, length};
  ConstKronVector v1(vraw1, m, n, depth);
  ConstVector vraw2{mmv.getData(), length, length};
  ConstKronVector v2(vraw2, m, n, depth);
  ConstVector craw1{mmc.getData(), 0, length};
  ConstKronVector c1(craw1, m, n, depth);
  ConstVector craw2{mmc.getData(), length, length};
  ConstKronVector c2(craw2, m, n, depth);
  KronVector x1(m, n, depth);
  KronVector x2(m, n, depth);
  ts.quaEval(alpha, betas, gamma, delta1, delta2, x1, x2, v1, v2);
  x1.add(-1, c1);
  x2.add(-1, c2);
  double norm1 = x1.getNorm();
  double norm2 = x2.getNorm();
  std::cout << "\terror norm1 = " << norm1 << "\n\terror norm2 = " << norm2 << std::endl;
  return (norm1*norm1+norm2*norm2 < 100*eps_norm*eps_norm); // relax norm
}

bool
TestRunnable::tri_sylv(const std::string &m1name, const std::string &m2name, const std::string &vname,
                       int m, int n, int depth)
{
  MMMatrixIn mmt1(m1name);
  MMMatrixIn mmt2(m2name);
  MMMatrixIn mmv(vname);

  int length = power(m, depth)*n;
  if (mmt1.row() != m
      || mmt2.row() != n
      || mmv.row() != length)
    {
      std::cout << "  Incompatible sizes for triangular sylvester action, len=" << length
                << ", row1=" << mmt1.row() << ", row2=" << mmt2.row()
                << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t1(mmt1.getData(), mmt1.row());
  QuasiTriangular t2(mmt2.getData(), mmt2.row());
  TriangularSylvester ts(t2, t1);
  Vector vraw{mmv.getData()};
  ConstKronVector v(vraw, m, n, depth);
  KronVector d(v); // copy of v
  SylvParams pars;
  ts.solve(pars, d);
  pars.print("\t");
  KronVector dcheck(const_cast<const KronVector &>(d));
  KronUtils::multKron(t1, t2, dcheck);
  dcheck.add(1.0, d);
  dcheck.add(-1.0, v);
  double norm = dcheck.getNorm();
  double xnorm = v.getNorm();
  std::cout << "\trel. error norm = " << norm/xnorm << std::endl;
  double max = dcheck.getMax();
  double xmax = v.getMax();
  std::cout << "\trel. error max = " << max/xmax << std::endl;
  return (norm < xnorm*eps_norm);
}

bool
TestRunnable::gen_sylv(const std::string &aname, const std::string &bname, const std::string &cname,
                       const std::string &dname, int m, int n, int order)
{
  MMMatrixIn mma(aname);
  MMMatrixIn mmb(bname);
  MMMatrixIn mmc(cname);
  MMMatrixIn mmd(dname);

  if (m != mmc.row() || m != mmc.col()
      || n != mma.row() || n != mma.col()
      || n != mmb.row() || n < mmb.col()
      || n != mmd.row() || power(m, order) != mmd.col())
    {
      std::cout << "  Incompatible sizes for gen_sylv.\n";
      return false;
    }

  SylvParams ps(true);
  GeneralSylvester gs(order, n, m, n-mmb.col(),
                      mma.getData(), mmb.getData(),
                      mmc.getData(), mmd.getData(),
                      ps);
  gs.solve();
  gs.check(mmd.getData());
  const SylvParams &pars = gs.getParams();
  pars.print("\t");
  return (*(pars.mat_err1) < eps_norm && *(pars.mat_errI) < eps_norm
          && *(pars.mat_errF) < eps_norm && *(pars.vec_err1) < eps_norm
          && *(pars.vec_errI) < eps_norm);
}

bool
TestRunnable::eig_bubble(const std::string &aname, int from, int to)
{
  MMMatrixIn mma(aname);

  if (mma.row() != mma.col())
    {
      std::cout << "  Matrix is not square\n";
      return false;
    }

  int n = mma.row();
  QuasiTriangular orig(mma.getData(), n);
  SchurDecompEig dec(const_cast<const QuasiTriangular &>(orig));
  QuasiTriangular::diag_iter itf = dec.getT().diag_begin();
  QuasiTriangular::diag_iter itt = dec.getT().diag_begin();
  for (int i = 0; i < from; i++)
    ++itf;
  for (int i = 0; i < to; i++)
    ++itt;
  itt = dec.bubbleEigen(itf, itt);
  SqSylvMatrix check(dec.getQ() * dec.getT());
  check.multRightTrans(dec.getQ());
  check.add(-1, orig);
  double norm1 = check.getNorm1();
  double normInf = check.getNormInf();
  double onorm1 = orig.getNorm1();
  double onormInf = orig.getNormInf();
  std::cout << "\tabs. error1 = " << norm1 << std::endl
            << "\tabs. error∞ = " << normInf << std::endl
            << "\trel. error1 = " << norm1/onorm1 << std::endl
            << "\trel. error∞ = " << normInf/onormInf << std::endl;
  return (norm1 < eps_norm*onorm1 && normInf < eps_norm*onormInf);
}

bool
TestRunnable::block_diag(const std::string &aname, double log10norm)
{
  MMMatrixIn mma(aname);

  if (mma.row() != mma.col())
    {
      std::cout << "  Matrix is not square\n";
      return false;
    }

  int n = mma.row();
  SqSylvMatrix orig(mma.getData(), n);
  SimilarityDecomp dec(orig.getData(), orig.nrows(), log10norm);
  dec.getB().printInfo();
  SqSylvMatrix check(dec.getQ() * dec.getB());
  check.multRight(dec.getInvQ());
  check.add(-1, orig);
  double norm1 = check.getNorm1();
  double normInf = check.getNormInf();
  double onorm1 = orig.getNorm1();
  double onormInf = orig.getNormInf();
  std::cout << "\terror Q·B·Q⁻¹:" << std::endl
            << "\tabs. error1 = " << norm1 << std::endl
            << "\tabs. error∞ = " << normInf << std::endl
            << "\trel. error1 = " << norm1/onorm1 << std::endl
            << "\trel. error∞ = " << normInf/onormInf << std::endl;
  SqSylvMatrix check2(dec.getQ() * dec.getInvQ());
  SqSylvMatrix in(n);
  in.setUnit();
  check2.add(-1, in);
  double nor1 = check2.getNorm1();
  double norInf = check2.getNormInf();
  std::cout << "\terror Q·Q⁻¹:" << std::endl
            << "\tabs. error1 = " << nor1 << std::endl
            << "\tabs. error∞ = " << norInf << std::endl;
  return (norm1 < eps_norm*pow(10, log10norm)*onorm1);
}

bool
TestRunnable::iter_sylv(const std::string &m1name, const std::string &m2name, const std::string &vname,
                        int m, int n, int depth)
{
  MMMatrixIn mmt1(m1name);
  MMMatrixIn mmt2(m2name);
  MMMatrixIn mmv(vname);

  int length = power(m, depth)*n;
  if (mmt1.row() != m
      || mmt2.row() != n
      || mmv.row() != length)
    {
      std::cout << "  Incompatible sizes for triangular sylvester iteration, len=" << length
                << ", row1=" << mmt1.row() << ", row2=" << mmt2.row()
                << ", m=" << m << ", n=" << n
                << ", vrow=" << mmv.row()
                << std::endl;
      return false;
    }

  QuasiTriangular t1(mmt1.getData(), mmt1.row());
  QuasiTriangular t2(mmt2.getData(), mmt2.row());
  IterativeSylvester is(t2, t1);
  Vector vraw{mmv.getData()};
  ConstKronVector v(vraw, m, n, depth);
  KronVector d(v); // copy of v
  SylvParams pars;
  pars.method = SylvParams::solve_method::iter;
  is.solve(pars, d);
  pars.print("\t");
  KronVector dcheck(const_cast<const KronVector &>(d));
  KronUtils::multKron(t1, t2, dcheck);
  dcheck.add(1.0, d);
  dcheck.add(-1.0, v);
  double cnorm = dcheck.getNorm();
  double xnorm = v.getNorm();
  std::cout << "\trel. error norm = " << cnorm/xnorm << std::endl;
  double max = dcheck.getMax();
  double xmax = v.getMax();
  std::cout << "\trel. error max = " << max/xmax << std::endl;
  return (cnorm < xnorm*eps_norm);
}

/**********************************************************/
/*   sub classes declarations                             */
/**********************************************************/

class PureTriangTest : public TestRunnable
{
public:
  PureTriangTest() : TestRunnable("pure triangular solve (5)")
  {
  }
  bool run() const override;
};

class PureTriangTransTest : public TestRunnable
{
public:
  PureTriangTransTest() : TestRunnable("pure triangular solve trans (5)")
  {
  }
  bool run() const override;
};

class PureTrLargeTest : public TestRunnable
{
public:
  PureTrLargeTest() : TestRunnable("pure triangular large solve (300)")
  {
  }
  bool run() const override;
};

class PureTrLargeTransTest : public TestRunnable
{
public:
  PureTrLargeTransTest() : TestRunnable("pure triangular large solve trans (300)")
  {
  }
  bool run() const override;
};

class QuasiTriangTest : public TestRunnable
{
public:
  QuasiTriangTest() : TestRunnable("quasi triangular solve (7)")
  {
  }
  bool run() const override;
};

class QuasiTriangTransTest : public TestRunnable
{
public:
  QuasiTriangTransTest() : TestRunnable("quasi triangular solve trans (7)")
  {
  }
  bool run() const override;
};

class QuasiTrLargeTest : public TestRunnable
{
public:
  QuasiTrLargeTest() : TestRunnable("quasi triangular solve large (250)")
  {
  }
  bool run() const override;
};

class QuasiTrLargeTransTest : public TestRunnable
{
public:
  QuasiTrLargeTransTest() : TestRunnable("quasi triangular solve large trans (250)")
  {
  }
  bool run() const override;
};

class QuasiZeroSmallTest : public TestRunnable
{
public:
  QuasiZeroSmallTest() : TestRunnable("quasi tr. zero small test (2×1)")
  {
  }
  bool run() const override;
};

class MultKronSmallTest : public TestRunnable
{
public:
  MultKronSmallTest() : TestRunnable("kronecker small mult (2=2×1)")
  {
  }
  bool run() const override;
};

class MultKronTest : public TestRunnable
{
public:
  MultKronTest() : TestRunnable("kronecker mult (245=7×7×5)")
  {
  }
  bool run() const override;
};

class MultKronSmallTransTest : public TestRunnable
{
public:
  MultKronSmallTransTest() : TestRunnable("kronecker small trans mult (2=2×1)")
  {
  }
  bool run() const override;
};

class MultKronTransTest : public TestRunnable
{
public:
  MultKronTransTest() : TestRunnable("kronecker trans mult (245=7×7×5)")
  {
  }
  bool run() const override;
};

class LevelKronTest : public TestRunnable
{
public:
  LevelKronTest() : TestRunnable("kronecker level mult (1715=7×[7]×7×5)")
  {
  }
  bool run() const override;
};

class LevelKronTransTest : public TestRunnable
{
public:
  LevelKronTransTest() : TestRunnable("kronecker level trans mult (1715=7×[7]×7×5)")
  {
  }
  bool run() const override;
};

class LevelZeroKronTest : public TestRunnable
{
public:
  LevelZeroKronTest() : TestRunnable("kronecker level mult (1715=7×7×7×[5])")
  {
  }
  bool run() const override;
};

class LevelZeroKronTransTest : public TestRunnable
{
public:
  LevelZeroKronTransTest() : TestRunnable("kronecker level trans mult (1715=7×7×7×[5])")
  {
  }
  bool run() const override;
};

class KronPowerTest : public TestRunnable
{
public:
  KronPowerTest() : TestRunnable("kronecker power mult (1715=7×7×7×5)")
  {
  }
  bool run() const override;
};

class SmallLinEvalTest : public TestRunnable
{
public:
  SmallLinEvalTest() : TestRunnable("lin eval (24=2 × 2×2×3)")
  {
  }
  bool run() const override;
};

class LinEvalTest : public TestRunnable
{
public:
  LinEvalTest() : TestRunnable("lin eval (490=2 × 7×7×5)")
  {
  }
  bool run() const override;
};

class SmallQuaEvalTest : public TestRunnable
{
public:
  SmallQuaEvalTest() : TestRunnable("qua eval (24=2 × 2×2×3)")
  {
  }
  bool run() const override;
};

class QuaEvalTest : public TestRunnable
{
public:
  QuaEvalTest() : TestRunnable("qua eval (490=2 × 7×7×5)")
  {
  }
  bool run() const override;
};

class TriSylvSmallRealTest : public TestRunnable
{
public:
  TriSylvSmallRealTest() : TestRunnable("triangular sylvester small real solve (12=2×2×3)")
  {
  }
  bool run() const override;
};

class TriSylvSmallComplexTest : public TestRunnable
{
public:
  TriSylvSmallComplexTest() : TestRunnable("triangular sylvester small complx solve (12=2×2×3)")
  {
  }
  bool run() const override;
};

class TriSylvTest : public TestRunnable
{
public:
  TriSylvTest() : TestRunnable("triangular sylvester solve (245=7×7×5)")
  {
  }
  bool run() const override;
};

class TriSylvBigTest : public TestRunnable
{
public:
  TriSylvBigTest() : TestRunnable("triangular sylvester big solve (48000=40×40×30)")
  {
  }
  bool run() const override;
};

class TriSylvLargeTest : public TestRunnable
{
public:
  TriSylvLargeTest() : TestRunnable("triangular sylvester large solve (1920000=40×40×40×30)")
  {
  }
  bool run() const override;
};

class IterSylvTest : public TestRunnable
{
public:
  IterSylvTest() : TestRunnable("iterative sylvester solve (245=7×7×5)")
  {
  }
  bool run() const override;
};

class IterSylvLargeTest : public TestRunnable
{
public:
  IterSylvLargeTest() : TestRunnable("iterative sylvester large solve (1920000=40×40×40×30)")
  {
  }
  bool run() const override;
};

class GenSylvSmallTest : public TestRunnable
{
public:
  GenSylvSmallTest() : TestRunnable("general sylvester small solve (18=3×3×2)")
  {
  }
  bool run() const override;
};

class GenSylvTest : public TestRunnable
{
public:
  GenSylvTest() : TestRunnable("general sylvester solve (12000=20×20×30)")
  {
  }
  bool run() const override;
};

class GenSylvSingTest : public TestRunnable
{
public:
  GenSylvSingTest() : TestRunnable("general sylvester solve for sing. C (2500000=50×50×50×20)")
  {
  }
  bool run() const override;
};

class GenSylvLargeTest : public TestRunnable
{
public:
  GenSylvLargeTest() : TestRunnable("general sylvester solve (2500000=50×50×50×20)")
  {
  }
  bool run() const override;
};

class EigBubFrankTest : public TestRunnable
{
public:
  EigBubFrankTest() : TestRunnable("eig. bubble frank test (12×12)")
  {
  }
  bool run() const override;
};

class EigBubSplitTest : public TestRunnable
{
  // complex eigenvalue is split by swapping it with real
public:
  EigBubSplitTest() : TestRunnable("eig. bubble complex split test (3×3)")
  {
  }
  bool run() const override;
};

class EigBubSameTest : public TestRunnable
{
  // complex eigenevalue bypasses the same complex eigenvalue
public:
  EigBubSameTest() : TestRunnable("eig. bubble same test (5×5)")
  {
  }
  bool run() const override;
};

class BlockDiagSmallTest : public TestRunnable
{
public:
  BlockDiagSmallTest() : TestRunnable("block diagonalization small test (7×7)")
  {
  }
  bool run() const override;
};

class BlockDiagFrankTest : public TestRunnable
{
public:
  BlockDiagFrankTest() : TestRunnable("block diagonalization of frank (12×12)")
  {
  }
  bool run() const override;
};

class BlockDiagIllCondTest : public TestRunnable
{
public:
  BlockDiagIllCondTest() : TestRunnable("block diagonalization of ill conditioned (15×15)")
  {
  }
  bool run() const override;
};

class BlockDiagBigTest : public TestRunnable
{
public:
  BlockDiagBigTest() : TestRunnable("block diagonalization big test (50×50)")
  {
  }
  bool run() const override;
};

/**********************************************************/
/*   run methods of sub classes                           */
/**********************************************************/

bool
PureTriangTest::run() const
{
  return quasi_solve(false, "tr5x5.mm", "v5.mm");
}

bool
PureTriangTransTest::run() const
{
  return quasi_solve(true, "tr5x5.mm", "v5.mm");
}

bool
PureTrLargeTest::run() const
{
  return quasi_solve(false, "tr300x300.mm", "v300.mm");
}

bool
PureTrLargeTransTest::run() const
{
  return quasi_solve(true, "tr300x300.mm", "v300.mm");
}

bool
QuasiTriangTest::run() const
{
  return quasi_solve(false, "qt7x7.mm", "v7.mm");
}

bool
QuasiTriangTransTest::run() const
{
  return quasi_solve(true, "qt7x7.mm", "v7.mm");
}

bool
QuasiTrLargeTest::run() const
{
  return quasi_solve(false, "qt250x250.mm", "v250.mm");
}

bool
QuasiTrLargeTransTest::run() const
{
  return quasi_solve(true, "qt250x250.mm", "v250.mm");
}

bool
QuasiZeroSmallTest::run() const
{
  return quasi_solve(false, "b2x1.mm", "v2.mm");
}

bool
MultKronSmallTest::run() const
{
  return mult_kron(false, "tr2x2.mm", "v2.mm", "vcheck2.mm", 2, 1, 1);
}

bool
MultKronTest::run() const
{
  return mult_kron(false, "qt7x7.mm", "v245.mm", "vcheck245.mm", 7, 5, 2);
}

bool
MultKronSmallTransTest::run() const
{
  return mult_kron(true, "tr2x2.mm", "v2.mm", "vcheck2a.mm", 2, 1, 1);
}

bool
MultKronTransTest::run() const
{
  return mult_kron(true, "qt7x7.mm", "v245.mm", "vcheck245a.mm", 7, 5, 2);
}

bool
LevelKronTest::run() const
{
  return level_kron(false, "qt7x7.mm", "v1715.mm", "vcheck1715.mm", 2, 7, 5, 3);
}

bool
LevelKronTransTest::run() const
{
  return level_kron(true, "qt7x7.mm", "v1715.mm", "vcheck1715a.mm", 2, 7, 5, 3);
}

bool
LevelZeroKronTest::run() const
{
  return level_kron(false, "tr5x5.mm", "v1715.mm", "vcheck1715b.mm", 0, 7, 5, 3);
}

bool
LevelZeroKronTransTest::run() const
{
  return level_kron(true, "tr5x5.mm", "v1715.mm", "vcheck1715c.mm", 0, 7, 5, 3);
}

bool
KronPowerTest::run() const
{
  return kron_power("qt7x7.mm", "tr5x5.mm", "v1715.mm", "vcheck1715d.mm", 7, 5, 3);
}

bool
SmallLinEvalTest::run() const
{
  return lin_eval("qt2x2.mm", "qt3x3.mm", "v24.mm", "vcheck24.mm", 2, 3, 2,
                  2, 1, 3);
}

bool
LinEvalTest::run() const
{
  return lin_eval("qt7x7.mm", "tr5x5.mm", "v490.mm", "vcheck490.mm", 7, 5, 2,
                  2, 1, 3);
}

bool
SmallQuaEvalTest::run() const
{
  return qua_eval("qt2x2.mm", "qt3x3.mm", "v24.mm", "vcheck24q.mm", 2, 3, 2,
                  -0.5, 3, 2, 1, 3);
}

bool
QuaEvalTest::run() const
{
  return qua_eval("qt7x7.mm", "tr5x5.mm", "v490.mm", "vcheck490q.mm", 7, 5, 2,
                  -0.5, 3, 2, 1, 3);
}

bool
TriSylvSmallRealTest::run() const
{
  return tri_sylv("tr2x2.mm", "qt3x3.mm", "v12r.mm", 2, 3, 2);
}

bool
TriSylvSmallComplexTest::run() const
{
  return tri_sylv("qt2x2.mm", "qt3x3.mm", "v12r.mm", 2, 3, 2);
}

bool
TriSylvTest::run() const
{
  return tri_sylv("qt7x7eig06-09.mm", "tr5x5.mm", "v245r.mm", 7, 5, 2);
}

bool
TriSylvBigTest::run() const
{
  return tri_sylv("qt40x40.mm", "qt30x30eig011-095.mm", "v48000.mm", 40, 30, 2);
}

bool
TriSylvLargeTest::run() const
{
  return tri_sylv("qt40x40.mm", "qt30x30eig011-095.mm", "v1920000.mm", 40, 30, 3);
}

bool
IterSylvTest::run() const
{
  return iter_sylv("qt7x7eig06-09.mm", "qt5x5.mm", "v245r.mm", 7, 5, 2);
}

bool
IterSylvLargeTest::run() const
{
  return iter_sylv("qt40x40.mm", "qt30x30eig011-095.mm", "v1920000.mm", 40, 30, 3);
}

bool
GenSylvSmallTest::run() const
{
  return gen_sylv("a2x2.mm", "b2x1.mm", "c3x3.mm", "d2x9.mm", 3, 2, 2);
}

bool
GenSylvTest::run() const
{
  return gen_sylv("a30x30.mm", "b30x25.mm", "c20x20.mm", "d30x400.mm", 20, 30, 2);
}

bool
GenSylvSingTest::run() const
{
  return gen_sylv("a20x20.mm", "b20x4.mm", "c50x50sing.mm", "d20x125000.mm", 50, 20, 3);
}

bool
GenSylvLargeTest::run() const
{
  return gen_sylv("a20x20.mm", "b20x15.mm", "c50x50.mm", "d20x125000.mm", 50, 20, 3);
}

bool
EigBubFrankTest::run() const
{
  return eig_bubble("qt_frank12x12.mm", 8, 0);
}

bool
EigBubSplitTest::run() const
{
  return eig_bubble("qt_eps3x3.mm", 1, 0);
}

bool
EigBubSameTest::run() const
{
  return eig_bubble("qt5x5.mm", 2, 0);
}

bool
BlockDiagSmallTest::run() const
{
  return block_diag("qt7x7.mm", 0.1);
}

bool
BlockDiagFrankTest::run() const
{
  return block_diag("qt_frank12x12.mm", 5);
}

bool
BlockDiagIllCondTest::run() const
{
  return block_diag("ill_cond15x15.mm", 4.14);
}

bool
BlockDiagBigTest::run() const
{
  return block_diag("c50x50.mm", 1.3);
}

/**********************************************************/
/*   main                                                 */
/**********************************************************/

int
main()
{
  std::vector<std::unique_ptr<TestRunnable>> all_tests;
  // fill in vector of all tests
  all_tests.push_back(std::make_unique<PureTriangTest>());
  all_tests.push_back(std::make_unique<PureTriangTransTest>());
  all_tests.push_back(std::make_unique<PureTrLargeTest>());
  all_tests.push_back(std::make_unique<PureTrLargeTransTest>());
  all_tests.push_back(std::make_unique<QuasiTriangTest>());
  all_tests.push_back(std::make_unique<QuasiTriangTransTest>());
  all_tests.push_back(std::make_unique<QuasiTrLargeTest>());
  all_tests.push_back(std::make_unique<QuasiTrLargeTransTest>());
  all_tests.push_back(std::make_unique<QuasiZeroSmallTest>());
  all_tests.push_back(std::make_unique<MultKronSmallTest>());
  all_tests.push_back(std::make_unique<MultKronTest>());
  all_tests.push_back(std::make_unique<MultKronSmallTransTest>());
  all_tests.push_back(std::make_unique<MultKronTransTest>());
  all_tests.push_back(std::make_unique<LevelKronTest>());
  all_tests.push_back(std::make_unique<LevelKronTransTest>());
  all_tests.push_back(std::make_unique<LevelZeroKronTest>());
  all_tests.push_back(std::make_unique<LevelZeroKronTransTest>());
  all_tests.push_back(std::make_unique<KronPowerTest>());
  all_tests.push_back(std::make_unique<SmallLinEvalTest>());
  all_tests.push_back(std::make_unique<LinEvalTest>());
  all_tests.push_back(std::make_unique<SmallQuaEvalTest>());
  all_tests.push_back(std::make_unique<QuaEvalTest>());
  all_tests.push_back(std::make_unique<EigBubFrankTest>());
  all_tests.push_back(std::make_unique<EigBubSplitTest>());
  all_tests.push_back(std::make_unique<EigBubSameTest>());
  all_tests.push_back(std::make_unique<BlockDiagSmallTest>());
  all_tests.push_back(std::make_unique<BlockDiagFrankTest>());
  all_tests.push_back(std::make_unique<BlockDiagIllCondTest>());
  all_tests.push_back(std::make_unique<BlockDiagBigTest>());
  all_tests.push_back(std::make_unique<TriSylvSmallRealTest>());
  all_tests.push_back(std::make_unique<TriSylvSmallComplexTest>());
  all_tests.push_back(std::make_unique<TriSylvTest>());
  all_tests.push_back(std::make_unique<TriSylvBigTest>());
  all_tests.push_back(std::make_unique<TriSylvLargeTest>());
  all_tests.push_back(std::make_unique<IterSylvTest>());
  all_tests.push_back(std::make_unique<IterSylvLargeTest>());
  all_tests.push_back(std::make_unique<GenSylvSmallTest>());
  all_tests.push_back(std::make_unique<GenSylvTest>());
  all_tests.push_back(std::make_unique<GenSylvSingTest>());
  all_tests.push_back(std::make_unique<GenSylvLargeTest>());

  // launch the tests
  std::cout << std::setprecision(4);
  int success = 0;
  for (const auto &test : all_tests)
    {
      try
        {
          if (test->test())
            success++;
        }
      catch (const MMException &e)
        {
          std::cout << "Caught MM exception in <" << test->name << ">:\n" << e.getMessage();
        }
      catch (SylvException &e)
        {
          std::cout << "Caught Sylv exception in " << test->name << ":\n";
          e.printMessage();
        }
    }

  int nfailed = all_tests.size() - success;
  std::cout << "There were " << nfailed << " tests that failed out of "
            << all_tests.size() << " tests run." << std::endl;

  if (nfailed)
    return EXIT_FAILURE;
  else
    return EXIT_SUCCESS;
}