MatrixBase.h

#ifndef _theplu_yat_utility_matrix_base_
#define _theplu_yat_utility_matrix_base_

// $Id: MatrixBase.h 4252 2022-11-18 02:54:04Z peter $

/*
  Copyright (C) 2003 Daniel Dalevi, Peter Johansson
  Copyright (C) 2004 Jari Häkkinen, Peter Johansson
  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
  Copyright (C) 2012, 2017, 2018, 2019, 2020, 2021, 2022 Peter Johansson

  This file is part of the yat library, https://dev.thep.lu.se/yat

  The yat library 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.

  The yat library 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 yat. If not, see <https://www.gnu.org/licenses/>.
*/

#include "config_public.h"

// include these operations as they are expected when using Matrix
#include "BLAS_level2.h"
#include "BLAS_level3.h"

#include "Container2DIterator.h"
#include "MatrixExpression.h"
#include "Vector.h"
#include "VectorConstView.h"
#include "VectorExpression.h"
#include "VectorView.h"
#include "yat_assert.h"

#include <gsl/gsl_matrix.h>

#include <cstddef> // size_t

namespace theplu {
namespace yat {
namespace utility {

  class MatrixBase : public BasicMatrix<MatrixBase>
  {
  public:
    typedef double value_type;

    typedef double& reference;

    typedef const double& const_reference;

    typedef Container2DIterator<const MatrixBase, const double, const double&>
    const_iterator;

    typedef StrideIterator<const double*> const_column_iterator;

    typedef StrideIterator<const double*> const_row_iterator;

    MatrixBase(void) = default;

    virtual ~MatrixBase(void);

    const_iterator begin(void) const;

    const_column_iterator begin_column(size_t i) const;

    const_row_iterator begin_row(size_t i) const;

    const VectorConstView column_const_view(size_t) const;

    size_t columns(void) const;

    const_iterator end(void) const;

    const_column_iterator end_column(size_t i) const;

    const_row_iterator end_row(size_t i) const;

    bool equal(const MatrixBase&, const double precision=0) const;

    virtual const gsl_matrix* gsl_matrix_p(void) const=0;

    size_t rows(void) const;

    const VectorConstView row_const_view(size_t) const;

    const double& operator()(size_t row,size_t column) const;

    bool operator==(const MatrixBase& other) const;

    bool operator!=(const MatrixBase& other) const;

  protected:
    gsl_matrix* create_gsl_matrix_copy(void) const;

  };

  bool isnull(const MatrixBase&);

  double max(const MatrixBase&);

  double min(const MatrixBase&);

  void minmax_index(const MatrixBase& M,
                    std::pair<size_t,size_t>& min,
                    std::pair<size_t,size_t>& max);

  std::ostream& operator<< (std::ostream& s, const MatrixBase&);

  double trace(const MatrixBase&);

}}} // of namespace utility, yat, and theplu

#endif