fvector.hh

Go to the documentation of this file.

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
// SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
#ifndef DUNE_COMMON_FVECTOR_HH
#define DUNE_COMMON_FVECTOR_HH
 
#include <algorithm>
#include <array>
#include <cmath>
#include <cstdlib>
#include <cstring>
#include <type_traits>
#include <utility>
#include <initializer_list>
 
#include <dune/common/boundschecking.hh>
#include <dune/common/densevector.hh>
#include <dune/common/ftraits.hh>
#include <dune/common/math.hh>
#include <dune/common/promotiontraits.hh>
#include <dune/common/typetraits.hh>
#include <dune/common/typeutilities.hh>
 
namespace Dune {
 
  template< class K, int SIZE > class FieldVector;
  template< class K, int SIZE >
  struct DenseMatVecTraits< FieldVector<K,SIZE> >
  {
    typedef FieldVector<K,SIZE> derived_type;
    typedef std::array<K,SIZE> container_type;
    typedef K value_type;
    typedef typename container_type::size_type size_type;
  };
 
  template< class K, int SIZE >
  struct FieldTraits< FieldVector<K,SIZE> >
  {
    typedef typename FieldTraits<K>::field_type field_type;
    typedef typename FieldTraits<K>::real_type real_type;
  };
 
  template<typename C, int SIZE>
  struct IsFieldVectorSizeCorrect
  {
    constexpr static bool value = true;
  };
 
  template<typename T, int SIZE>
  struct IsFieldVectorSizeCorrect<FieldVector<T,SIZE>,SIZE>
  {
    constexpr static bool value = true;
  };
 
  template<typename T, int SIZE, int SIZE1>
  struct IsFieldVectorSizeCorrect<FieldVector<T,SIZE1>,SIZE>
  {
    constexpr static bool value = false;
  };
 
 
  template< class K, int SIZE >
  class FieldVector :
    public DenseVector< FieldVector<K,SIZE> >
  {
    std::array<K,SIZE> _data;
    typedef DenseVector< FieldVector<K,SIZE> > Base;
  public:
    constexpr static int dimension = SIZE;
 
    typedef typename Base::size_type size_type;
    typedef typename Base::value_type value_type;
 
    typedef value_type& reference;
 
    typedef const value_type& const_reference;
 
    constexpr FieldVector () noexcept
      : _data{}
    {}
 
    explicit constexpr FieldVector (const K& k)
        noexcept(std::is_nothrow_copy_assignable_v<K>)
    : FieldVector()
    {
      std::fill(_data.begin(), _data.end(), k);
    }
 
    constexpr FieldVector (const std::initializer_list<K>& l)
      : _data{}
    {
      assert(l.size() == dimension);
      for (int i = 0; i < dimension; ++i)
        _data[i] = std::data(l)[i];
    }
 
    template<class T,
      std::enable_if_t<IsFieldVectorSizeCorrect<T,dimension>::value, int> = 0,
      decltype(std::declval<K&>() = std::declval<const T&>()[0], bool{}) = true>
    constexpr FieldVector (const DenseVector<T>& x)
    : FieldVector()
    {
      assert(x.size() == dimension);
      for (int i = 0; i < dimension; ++i)
        _data[i] = x[i];
    }
 
    template<class T,
      std::enable_if_t<std::is_assignable_v<K&, const T&>, int> = 0>
    explicit constexpr FieldVector (const FieldVector<T, SIZE>& x)
        noexcept(std::is_nothrow_assignable_v<K&, const T&>)
    : FieldVector()
    {
      for (int i = 0; i < dimension; ++i)
        _data[i] = x[i];
    }
 
    template<class K1, int SIZE1,
      std::enable_if_t<(SIZE1 != SIZE), int> = 0>
    explicit FieldVector (const FieldVector<K1, SIZE1>&) = delete;
 
    constexpr FieldVector (const FieldVector&) = default;
 
 
    template<class T,
      std::enable_if_t<IsFieldVectorSizeCorrect<T,dimension>::value, int> = 0,
      decltype(std::declval<K&>() = std::declval<const T&>()[0], bool{}) = true>
    constexpr FieldVector& operator= (const DenseVector<T>& x)
    {
      assert(x.size() == dimension);
      for (int i = 0; i < dimension; ++i)
        _data[i] = x[i];
      return *this;
    }
 
    template<class T,
      std::enable_if_t<std::is_assignable_v<K&, const T&>, int> = 0>
    constexpr FieldVector& operator= (const FieldVector<T, SIZE>& x)
        noexcept(std::is_nothrow_assignable_v<K&, const T&>)
    {
      for (int i = 0; i < dimension; ++i)
        _data[i] = x[i];
      return *this;
    }
 
    template<class K1, int SIZE1,
      std::enable_if_t<(SIZE1 != SIZE), int> = 0>
    constexpr FieldVector& operator= (const FieldVector<K1, SIZE1>&) = delete;
 
    constexpr FieldVector& operator= (const FieldVector&) = default;
 
    using Base::operator=;
 
    static constexpr size_type size () noexcept { return dimension; }
 
    constexpr reference operator[] (size_type i)
    {
      DUNE_ASSERT_BOUNDS(i < dimension);
      return _data[i];
    }
 
    constexpr const_reference operator[] (size_type i) const
    {
      DUNE_ASSERT_BOUNDS(i < dimension);
      return _data[i];
    }
 
    constexpr K* data () noexcept
    {
      return _data.data();
    }
 
    constexpr const K* data () const noexcept
    {
      return _data.data();
    }
 
    template<class Scalar,
      std::enable_if_t<IsNumber<Scalar>::value, int> = 0>
    friend constexpr auto operator* (const FieldVector& vector, Scalar scalar)
    {
      using T = typename PromotionTraits<value_type,Scalar>::PromotedType;
      FieldVector<T,SIZE> result;
 
      for (size_type i = 0; i < vector.size(); ++i)
        result[i] = vector[i] * scalar;
      return result;
    }
 
    template<class Scalar,
      std::enable_if_t<IsNumber<Scalar>::value, int> = 0>
    friend constexpr auto operator* (Scalar scalar, const FieldVector& vector)
    {
      using T = typename PromotionTraits<value_type,Scalar>::PromotedType;
      FieldVector<T,SIZE> result;
 
      for (size_type i = 0; i < vector.size(); ++i)
        result[i] = scalar * vector[i];
      return result;
    }
 
    template<class Scalar,
      std::enable_if_t<IsNumber<Scalar>::value, int> = 0>
    friend constexpr auto operator/ (const FieldVector& vector, Scalar scalar)
    {
      using T = typename PromotionTraits<value_type,Scalar>::PromotedType;
      FieldVector<T,SIZE> result;
 
      for (size_type i = 0; i < vector.size(); ++i)
        result[i] = vector[i] / scalar;
 
      return result;
    }
 
  };
 
  template<class K, int SIZE>
  std::istream &operator>> (std::istream& in, FieldVector<K, SIZE>& v)
  {
    FieldVector<K, SIZE> w;
    for (int i = 0; i < SIZE; ++i)
      in >> w[i];
    if (in)
      v = w;
    return in;
  }
 
#ifndef DOXYGEN
  template< class K >
  struct DenseMatVecTraits< FieldVector<K,1> >
  {
    typedef FieldVector<K,1> derived_type;
    typedef K container_type;
    typedef K value_type;
    typedef size_t size_type;
  };
 
  template<class K>
  class FieldVector<K, 1> :
    public DenseVector< FieldVector<K,1> >
  {
    K _data;
    typedef DenseVector< FieldVector<K,1> > Base;
  public:
    constexpr static int dimension = 1;
 
    typedef typename Base::size_type size_type;
 
    typedef K& reference;
 
    typedef const K& const_reference;
 
    //===== construction
 
    constexpr FieldVector () noexcept
      : _data()
    {}
 
    template<class T,
      std::enable_if_t<std::is_constructible_v<K,T>, int> = 0>
    constexpr FieldVector (const T& k) noexcept
      : _data(k)
    {}
 
    constexpr FieldVector (const std::initializer_list<K>& l)
    {
      assert(l.size() == 1);
      _data = *l.begin();
    }
 
    template<class T,
      std::enable_if_t<std::is_constructible_v<K,T>, int> = 0>
    constexpr FieldVector (const FieldVector<T,1>& x) noexcept
      : _data(x[0])
    {}
 
    template<class T,
      std::enable_if_t<IsFieldVectorSizeCorrect<T,1>::value, int> = 0,
      decltype(std::declval<K&>() = std::declval<const T&>()[0], bool{}) = true>
    constexpr FieldVector (const DenseVector<T>& x)
    {
      assert(x.size() == 1);
      _data = x[0];
    }
 
    constexpr FieldVector (const FieldVector&) = default;
 
    constexpr FieldVector& operator= (const FieldVector&) = default;
 
    template<class T,
      decltype(std::declval<K&>() = std::declval<const T&>(), bool{}) = true>
    constexpr FieldVector& operator= (const FieldVector<T,1>& other) noexcept
    {
      _data = other[0];
      return *this;
    }
 
    template<class T,
      std::enable_if_t<IsFieldVectorSizeCorrect<T,1>::value, int> = 0,
      decltype(std::declval<K&>() = std::declval<const T&>()[0], bool{}) = true>
    constexpr FieldVector& operator= (const DenseVector<T>& other)
    {
      assert(other.size() == 1);
      _data = other[0];
      return *this;
    }
 
    template<class T,
      decltype(std::declval<K&>() = std::declval<const T&>(), bool{}) = true>
    constexpr FieldVector& operator= (const T& k) noexcept
    {
      _data = k;
      return *this;
    }
 
    //===== forward methods to container
    static constexpr size_type size () noexcept { return 1; }
 
    constexpr reference operator[] ([[maybe_unused]] size_type i)
    {
      DUNE_ASSERT_BOUNDS(i == 0);
      return _data;
    }
    constexpr const_reference operator[] ([[maybe_unused]] size_type i) const
    {
      DUNE_ASSERT_BOUNDS(i == 0);
      return _data;
    }
 
    constexpr K* data () noexcept
    {
      return &_data;
    }
 
    constexpr const K* data () const noexcept
    {
      return &_data;
    }
 
    //===== conversion operator
 
    constexpr operator reference () noexcept { return _data; }
 
    constexpr operator const_reference () const noexcept { return _data; }
  };
 
  /* ----- FV / FV ----- */
  /* mostly not necessary as these operations are already covered via the cast operator */
 
  template<class K>
  constexpr bool operator> (const FieldVector<K,1>& a, const FieldVector<K,1>& b) noexcept
  {
    return a[0]>b[0];
  }
 
  template<class K>
  constexpr bool operator>= (const FieldVector<K,1>& a, const FieldVector<K,1>& b) noexcept
  {
    return a[0]>=b[0];
  }
 
  template<class K>
  constexpr bool operator< (const FieldVector<K,1>& a, const FieldVector<K,1>& b) noexcept
  {
    return a[0]<b[0];
  }
 
  template<class K>
  constexpr bool operator<= (const FieldVector<K,1>& a, const FieldVector<K,1>& b) noexcept
  {
    return a[0]<=b[0];
  }
 
  /* ----- FV / scalar ----- */
 
  template<class K>
  constexpr FieldVector<K,1> operator+ (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]+b;
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator- (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]-b;
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator* (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]*b;
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator/ (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]/b;
  }
 
  template<class K>
  constexpr bool operator> (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]>b;
  }
 
  template<class K>
  constexpr bool operator>= (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]>=b;
  }
 
  template<class K>
  constexpr bool operator< (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]<b;
  }
 
  template<class K>
  constexpr bool operator<= (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]<=b;
  }
 
  template<class K>
  constexpr bool operator== (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]==b;
  }
 
  template<class K>
  constexpr bool operator!= (const FieldVector<K,1>& a, const K b) noexcept
  {
    return a[0]!=b;
  }
 
  /* ----- scalar / FV ------ */
 
  template<class K>
  constexpr FieldVector<K,1> operator+ (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a+b[0];
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator- (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a-b[0];
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator* (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a*b[0];
  }
 
  template<class K>
  constexpr FieldVector<K,1> operator/ (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a/b[0];
  }
 
  template<class K>
  constexpr bool operator> (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a>b[0];
  }
 
  template<class K>
  constexpr bool operator>= (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a>=b[0];
  }
 
  template<class K>
  constexpr bool operator< (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a<b[0];
  }
 
  template<class K>
  constexpr bool operator<= (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a<=b[0];
  }
 
  template<class K>
  constexpr bool operator== (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a==b[0];
  }
 
  template<class K>
  constexpr bool operator!= (const K a, const FieldVector<K,1>& b) noexcept
  {
    return a!=b[0];
  }
#endif
 
  /* Overloads for common classification functions */
  namespace MathOverloads {
 
    template<class K, int SIZE>
    auto isFinite (const FieldVector<K,SIZE>& b, PriorityTag<2>, ADLTag)
    {
      bool out = true;
      for (int i = 0; i < SIZE; ++i) {
        out &= Dune::isFinite(b[i]);
      }
      return out;
    }
 
    template<class K, int SIZE>
    bool isInf (const FieldVector<K,SIZE>& b, PriorityTag<2>, ADLTag)
    {
      bool out = false;
      for (int i = 0; i < SIZE; ++i) {
        out |= Dune::isInf(b[i]);
      }
      return out;
    }
 
    template<class K, int SIZE,
      std::enable_if_t<HasNaN<K>::value, int> = 0>
    bool isNaN (const FieldVector<K,SIZE>& b, PriorityTag<2>, ADLTag)
    {
      bool out = false;
      for (int i = 0; i < SIZE; ++i) {
        out |= Dune::isNaN(b[i]);
      }
      return out;
    }
 
    template<class K,
      std::enable_if_t<HasNaN<K>::value, int> = 0>
    bool isUnordered (const FieldVector<K,1>& b, const FieldVector<K,1>& c,
                      PriorityTag<2>, ADLTag)
    {
      return Dune::isUnordered(b[0],c[0]);
    }
 
  } // end namespace MathOverloads
 
} // end namespace Dune
 
#endif // DUNE_COMMON_FVECTOR_HH