BelosDenseMatTraits.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
//
#ifndef BELOS_DENSE_MAT_TRAITS_HPP
#define BELOS_DENSE_MAT_TRAITS_HPP
 
//#include "BelosConfigDefs.hpp"
 
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"
 
#include "BelosDenseSolver.hpp"
 
namespace Belos {
 
  template< class ScalarType, class DM >
  struct UndefinedDenseMatTraits
  {
 
    static inline ScalarType notDefined() { return DM::this_type_is_missing_a_specialization(); };
  };
  
  template<class ScalarType, class DM>
  class DenseMatTraits 
  {
  public:
    
 
    static Teuchos::RCP<DM> Create()
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    static Teuchos::RCP<DM> Create( const int numrows, const int numcols, bool initZero = true)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    static Teuchos::RCP<DM> CreateCopy(const DM & dm, bool transpose=false)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }
 
/* Kokkos Ex View-from-ptr constructor: 
View(const pointer_type &ptr, const IntType&... indices)
 
    Unmanaged data wrapping constructor.
 
        ptr: pointer to a user provided memory allocation. Must provide storage of size View::required_allocation_size(n0,...,nR)
        indices: Extents of the View.
        Requires: sizeof(IntType...)==rank_dynamic() or sizeof(IntType...)==rank(). In the latter case, the extents corresponding to compile-time dimensions must match the View type’s compile-time extents.
        Requires: array_layout::is_regular == true.
*/
 
    static ScalarType* GetRawHostPtr(DM & dm )
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    static ScalarType const * GetConstRawHostPtr(const DM & dm )  
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    //static void RawPtrDataModified(DM & dm)
    //{ UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    //        Row and column indexing is zero-based.
    //        Source  - Reference to another dense matrix from which values are to be copied.
    //        numRows - The number of rows in this matrix.
    //        numCols - The number of columns in this matrix.
    //        startRow  - The row of Source from which the submatrix copy should start.
    //        startCol  - The column of Source from which the submatrix copy should start.
    //
    //        Should ints be const? Should they be ints or some other ordinal type?
    static Teuchos::RCP<DM> Subview( DM & source, int numRows, int numCols, int startRow=0, int startCol=0)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    static Teuchos::RCP<const DM> SubviewConst( const DM & source, int numRows, int numCols, int startRow=0, int startCol=0)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
    static Teuchos::RCP<DM> SubviewCopy( const DM & source, int numRows, int numCols, int startRow=0, int startCol=0)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }     
 
 
    static int GetNumRows( const DM& dm )
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return 0; }     
 
    static int GetNumCols( const DM& dm )
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return 0; }     
 
    static int GetStride( const DM& dm )
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return 0; }     
 
 
 
    /* \brief Reshaping method for changing the size of \c dm,
    *         keeping the entries. 
    */
    
    /* \brief Reshaping method for changing the size of \c dm to have \c numrows rows and \c numcols columns.
     *        All values will be initialized to zero if the final argument is true. 
     *        If the final argument is fale, the previous entries in 
     *        the matrix will be maintained. For new entries that did not exist in the previous matrix, values will
     *        contain noise from memory. 
    */
    static void Reshape( DM& dm, const int numrows, const int numcols, bool initZero = false)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }     
 
 
 
    static ScalarType & Value( DM& dm, const int i, const int j )
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static const ScalarType & ValueConst( const DM& dm, const int i, const int j ) 
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
    
    static void SyncDeviceToHost(DM & dm)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static void SyncHostToDevice(DM & dm)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
 
    
    static void Add( DM& thisDM, const DM& sourceDM)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static void PutScalar( DM& dm, ScalarType value = Teuchos::ScalarTraits<ScalarType>::zero()) 
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static void Scale( DM& dm, ScalarType value)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static void Randomize( DM& dm)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static void Assign( DM& thisDM, const DM& sourceDM)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static typename Teuchos::ScalarTraits<ScalarType>::magnitudeType NormFrobenius(const DM& dm)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
    static typename Teuchos::ScalarTraits<ScalarType>::magnitudeType NormOne(const DM& dm)
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); }
 
 
 
    static Teuchos::RCP<DenseSolver<ScalarType, DM>> createDenseSolver()
    { UndefinedDenseMatTraits<ScalarType, DM>::notDefined(); return Teuchos::null; }
 
  };
 
} // namespace Belos
 
#endif // end file BELOS_DENSE_MAT_TRAITS_HPP