Kokkos_InnerProductSpaceTraits.hpp

Go to the documentation of this file.

/*
//@HEADER
// ************************************************************************
//
//   Kokkos: Manycore Performance-Portable Multidimensional Arrays
//              Copyright (2012) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact  H. Carter Edwards (hcedwar@sandia.gov)
//
// ************************************************************************
//@HEADER
*/

#ifndef KOKKOS_INNERPRODUCTSPACETRAITS_HPP
#define KOKKOS_INNERPRODUCTSPACETRAITS_HPP


#include "Kokkos_ArithTraits.hpp"

namespace Kokkos {
namespace Details {

template<class T>
class InnerProductSpaceTraits {
public:
  typedef T val_type;

  typedef typename ArithTraits<T>::mag_type mag_type;

  typedef T dot_type;

  static KOKKOS_FORCEINLINE_FUNCTION mag_type norm (const T& x) {
    return ArithTraits<T>::abs (x);
  }
  static KOKKOS_FORCEINLINE_FUNCTION dot_type dot (const T& x, const T& y) {
    return x * y;
  }
};


// CUDA does not support long double in device functions.
template<>
struct InnerProductSpaceTraits<long double>
{
  typedef long double val_type;
  typedef ArithTraits<val_type>::mag_type mag_type;
  typedef val_type dot_type;

  static mag_type norm (const val_type& x) {
    return ArithTraits<val_type>::abs (x);
  }
  static dot_type dot (const val_type& x, const val_type& y) {
    return x * y;
  }
};


// CUDA does not support std::complex<T> in device functions.
template<class T>
struct InnerProductSpaceTraits<std::complex<T> >
{
  typedef std::complex<T> val_type;
  typedef typename ArithTraits<val_type>::mag_type mag_type;
  typedef val_type dot_type;

  static mag_type norm (const val_type& x) {
    return ArithTraits<val_type>::abs (x);
  }
  static dot_type dot (const val_type& x, const val_type& y) {
    return x * y;
  }
};


// dd_real and qd_real are floating-point types provided by the QD
// library of David Bailey (LBNL):
//
// http://crd-legacy.lbl.gov/~dhbailey/mpdist/
//
// dd_real uses two doubles (128 bits), and qd_real uses four doubles
// (256 bits).
//
// Kokkos does <i>not</i> currently support these types in device
// functions.  It should be possible to use Kokkos' support for
// aggregate types to implement device function support for dd_real
// and qd_real, but we have not done this yet (as of 07 Jan 2014).
// Hence, the class methods of the ArithTraits specializations for
// dd_real and qd_real are not marked as device functions.
#ifdef HAVE_KOKKOS_QD
template<>
struct InnerProductSpaceTraits<dd_real>
{
  typedef dd_real val_type;
  typedef ArithTraits<val_type>::mag_type mag_type;
  typedef val_type dot_type;

  static mag_type norm (const val_type& x) {
    return ArithTraits<val_type>::abs (x);
  }
  static dot_type dot (const val_type& x, const val_type& y) {
    return x * y;
  }
};

template<>
struct InnerProductSpaceTraits<qd_real>
{
  typedef qd_real val_type;
  typedef ArithTraits<val_type>::mag_type mag_type;
  typedef val_type dot_type;

  static mag_type norm (const val_type& x) {
    return ArithTraits<val_type>::abs (x);
  }
  static dot_type dot (const val_type& x, const val_type& y) {
    return x * y;
  }
};
#endif // HAVE_KOKKOS_QD

} // namespace Details
} // namespace Kokkos

#endif // KOKKOS_INNERPRODUCTSPACETRAITS_HPP