VectorBase.h

#ifndef _theplu_yat_utility_vector_base_
#define _theplu_yat_utility_vector_base_

// $Id: VectorBase.h 3871 2020-03-01 22:46:57Z peter $

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

  This file is part of the yat library, http://dev.thep.lu.se/trac/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 <http://www.gnu.org/licenses/>.
*/

#include "BasicVector.h"
#include "BLAS_level1.h"// include these as they are expected when using Vector
#include "BLAS_level2.h"// include these as they are expected when using Vector
#include "StrideIterator.h"
#include "VectorExpression.h"

#include <iosfwd>
#include <vector>
#include <cstddef> // size_t

#include <gsl/gsl_vector.h>

namespace theplu {
namespace yat {
namespace utility {

  class Vector;

  class VectorBase : public BasicVector<VectorBase>
  {
  public:
    typedef double value_type;

    typedef const double& const_reference;

    typedef StrideIterator<const double*> const_iterator;

    VectorBase(const gsl_vector* v=NULL);

    virtual ~VectorBase(void);

    const_iterator begin(void) const;

    const_iterator end(void) const;

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

    const gsl_vector* gsl_vector_p(void) const;

    virtual bool isview(void) const=0;

    size_t size(void) const;

    const double& operator()(size_t i) const;

    bool operator==(const VectorBase&) const;

    bool operator!=(const VectorBase&) const;

    double operator*(const VectorBase&) const;

  protected:
    const gsl_vector* const_vec_;

  private:
    // copy assignment not allowed
    const VectorBase& operator=(const VectorBase&);
  };

  bool isnull(const VectorBase&);

  double max(const VectorBase&);

  size_t max_index(const VectorBase&);

  double min(const VectorBase&);

  size_t min_index(const VectorBase&);

  bool nan(const VectorBase& templat, Vector& flag);

  double norm2_squared(const VectorBase& v);


  void sort_index(std::vector<size_t>& sort_index, const VectorBase& invec);

  void sort_smallest_index(std::vector<size_t>& sort_index, size_t k,
                           const VectorBase& invec);

  void sort_largest_index(std::vector<size_t>& sort_index, size_t k,
                          const VectorBase& invec);

  double sum(const VectorBase&);

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


  // Some convenience functions used in Vector and friends.
  namespace detail {

    gsl_vector* create_gsl_vector(size_t n);

    gsl_vector* create_gsl_vector(size_t n, double init);

    gsl_vector* create_gsl_vector_copy(const gsl_vector*);


    // return true if a and b overlap in memory
    bool overlap(const gsl_vector* a, const gsl_vector* b);

    /*
      Is a stricter condition that overlap(2). Basically it returns
      false if it is safe to write code like:
      for (size_t i=0; i<a->size; ++i)
        a[i] = foo(b[i])

      in other words, it returns true if there exists i and j, i<j, such that
      gsl_vector_const_ptr(a, j) == gsl_vector_const_ptr(b, i)

      For speed reasons function might return true in some cases when
      condition above is not true, when both a and b have stride>1 and
      elements sit between each other.

      Note, a and b must have same size.
     */
    bool serial_overlap(const gsl_vector* a, const gsl_vector* b);
  }


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

#endif