Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Kokkos_Mkl_MatrixDescriptor.hpp
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //          Kokkos: Node API and Parallel Node Kernels
00005 //              Copyright (2008) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #ifndef __Kokkos_Mkl_MatrixDescriptor_hpp
00043 #define __Kokkos_Mkl_MatrixDescriptor_hpp
00044 
00045 #include <Teuchos_BLAS_types.hpp>
00046 #include <Teuchos_FancyOStream.hpp>
00047 #include <string>
00048 
00049 namespace Kokkos {
00050   namespace Mkl {
00061     class MatrixDescriptor {
00062     public:
00103       MatrixDescriptor (const bool symmetric,
00104                         const bool hermitian,
00105                         const bool triangular,
00106                         const bool skewSymmetric,
00107                         const bool diagonal,
00108                         const Teuchos::EUplo uplo,
00109                         const Teuchos::EDiag diag,
00110                         const int indexBase);
00111 
00113       MatrixDescriptor ();
00114 
00122       const char* const getRawPtr () const {
00123         return &descr_[0];
00124       }
00125 
00127       Teuchos::EDiag getDiag () const;
00128 
00130       Teuchos::EUplo getUplo () const;
00131 
00133       int getIndexBase () const;
00134 
00147       void print (Teuchos::FancyOStream& out) const;
00148 
00149     private:
00160       static void
00161       fill (std::string& descr,
00162             const bool symmetric,
00163             const bool hermitian,
00164             const bool triangular,
00165             const bool skewSymmetric,
00166             const bool diagonal,
00167             const Teuchos::EUplo uplo,
00168             const Teuchos::EDiag diag,
00169             const int indexBase);
00170 
00172       std::string descr_;
00173     };
00174   } // namespace Mkl
00175 } // namespace Kokkos
00176 
00177 #endif // __Kokkos_Mkl_MatrixDescriptor_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends